Edit an existing collection.

Resource URL

https://sxcu.net/api/

Parameters

Parameter Description Optional Default
action String. Must be set to edit_collection No None
collection_id String. The ID of the collection to be edited. No None
collection_token String. The current token of that collection. Required to make any edits. No None
title String. The new title of the collection. Yes None
desc String. The new description of the collection. Yes None
unlisted boolean. The new unlisted setting of the collection. Yes None
regen_token Void. if set will generate a new token for the collection and return it in the response. Yes None
empty_collection Void. if set will disassociate all of the images in the collection from it. Yes None
delete_collection Void. if set will disassociate all of the images in the collection from it and delete the collection. Yes None

Example

POST https://sxcu.net/api/

Request

action=edit_collection
collection_id=HgiuYA
collection_token=b96daa53-d857-49a9-aad1-730986009c66
title=New title

Response JSON Params

Parameter Type Description
token String The new token for the collection, will be present if regen_token was present in the request.

Resource Information

Rate Limited 1 request per 2 minutes
Response Format JSON
Authentication None