FEEDS


METHOD

/api/feeds/set.php

This method adds feeds, edit feeds names & URLs and link folder ids.


ENDPOINT

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


PARAMETERS POST

PARAMETER DEFAULT REQUIRED NOTES
api_key null Yes API key can be retrieved from /api/auth/login.php
feed_name null No If a feed_id is passed with this parameter, the existing feed name will be updated. Otherwise a new feed will be created.
feed_url null No If a feed_id is passed with this parameter, the existing feed URL will be updated. Otherwise a new feed will be created.
feed_id null No This parameter is used to update feed_name, feed_url or folder_ids linked to a feed. If folder_ids is passed into the call, this parameter is required.
folder_ids null No A comma separated list of folder ids. This must be passed together with the feed_id so Cranked knows which feed to link these folder 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
feed_name, feed_url or folder_ids not passed A feed_id was passed into the API call but Cranked doesn't know what to do with it as no feed_name, feed_url or folder_ids were passed into the call
feed_id not passed The folder_ids parameter was passed into the API call but Cranked doesn't know which feed to tie them to as no feed_id was passed into the call.