FOLDERS


METHOD

/api/folders/set.php

This method adds folders, edit folder names and link feed ids.


ENDPOINT

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


PARAMETERS POST

PARAMETER DEFAULT REQUIRED NOTES
api_key null Yes API key can be retrieved from /api/auth/login.php
folder_name null No If a folder_id is passed with this parameter, the existing folder name will be updated. Otherwise a new folder will be created.
folder_id null No This parameter is used to update folder_name or feed_ids linked to a folder. If feed_ids is passed into the call, this parameter is required.
feed_ids null No A comma separated list of feed ids. This must be passed together with the folder_id so Cranked knows which folder to link these feed ids to.

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
folder_name or feed_ids not passed A folder_id was passed into the API call but Cranked doesn't know what to do with it as no folder_name or feed_ids were passed into the call
folder_id not passed The feed_ids parameter was passed into the API call but Cranked doesn't know which folder to tie them to as no folder_id was passed into the call.