Skip to navigation

Remove Collection Item

Remove or unpublish an item in a collection. <aside class=“notice”>Remove Item
The default behavior of the endpoint will delete the item from collection. You cannot retrieve a deleted item.

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
deleteddoubleOptional
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