SETTINGS


METHOD

/api/settings/set.php

This method updates user settings.


ENDPOINT

http://cranked_installation_url/api/settings/set.php


PARAMETERS POST

PARAMETER DEFAULT REQUIRED NOTES
api_key null Yes API key can be retrieved from /api/auth/login.php
email null No User's login email address
password null No User's login password
readability_token null No User's Readability token
remember_mobilizer_status null No When user clicks 'Mobilize' for any article, whether this setting is remembered or not depends on this remember_mobilizer_status setting. Value should be 1 or 0.
scroll_mark_as_read null No 1 to mark articles as read when scrolling pass. 0 to not mark articles as read when scrolling pass.
delete_unsaved null No The default value is '2 weeks'. Value should be in natural human language, eg. '1 week', '10 days' etc.
show_excerpt null No 1 to show articles as excerpt. 0 to show articles' full content when displaying articles.
show_unread_count null No 1 to show unread count. 0 to 'not show' unread count.
newest_first null No 1 to set the order of loaded articles from the newest first. 0 to set the order of the loaded articles from the oldest first.
sort_by_trending null No Toggle between 1 or 0 when user clicks 'CRANK UP THE FEEDS'.

SUCCESS RESPONSE

{"result":"success"}

ERROR RESPONSE

ERROR MESSAGE NOTES
No data passed API was called but no data were passed
API key not passed The required API key was not passed into the call
Invalid API key The API key was passed into the call but is invalid
No actions passed No parameters was passed into the API call other than the API key