CMSItems

Remove Collection Items

Remove or unpublish items 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

Headers

Accept-VersionstringOptional
The API version

Query parameters

livebooleanOptional

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

Request

The collection item ids to delete or unpublish
itemIdslist of stringsOptional
Array of item ids to delete or unpublish

Response

Request was successful
deletedItemIdslist of strings or null
Array of deleted item ids
errorslist of strings or null
Array of errors

Errors