CMSItems

Remove Collection Item

Remove or unpublish an item in a collection. <aside class="notice"><b>Remove Item</b><br/> The default behavior of the endpoint will delete the item from collection. You cannot retrieve a deleted item. <br/><br/> <aside class="notice"><b>Unpublish Item</b><br/> It is possible to only remove the item from the published site, while maintaining it in your collection. Unpublishing an item will set the item status to Draft. <br/><br/> Append <code>?live=true</code> to the querystring to unpublish an item</aside>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

collection_idstringRequiredformat: "uuid"
Unique identifier for a Collection
item_idstringRequiredformat: "uuid"
Unique identifier for and Item

Headers

Accept-VersionstringOptional
The API version

Query parameters

livebooleanOptional

Boolean indicating if the item(s) should be published/unpublished to/from the live site

Response

Request was successful
deleteddouble
Number of records deleted

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error