ITEMS


METHOD

/api/items/mark-folder-as-read.php

This method marks all items from a particular folder as read.


ENDPOINT

http://cranked_installation_url/api/items/mark-folder-as-read.php


PARAMETERS POST

PARAMETER DEFAULT REQUIRED NOTES
api_key null Yes API key can be retrieved from /api/auth/login.php
folder_id null No The id of the folder you want to mark all its items as read. If you do not pass the folder_id into the API call, ALL items in Cranked will be marked as read.

SUCCESS RESPONSE

{
   "result":"success",
   "total_unread_count":"2649"
}

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