CMSItems

Patch Collection Item

Update only fields that need to be changed. To upload a new image set the image URL to the corresponding item's field. Collection items that reuse images previously uploaded can just reference their fileId property.

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

Request

The item to update
fieldsobjectOptional
Fields in your collection item

Response

Request was successful
_archivedboolean or nullDefaults to false
Boolean determining if the Item is set to archived
_draftboolean or nullDefaults to false
Boolean determining if the Item is set to draft
_idstring or null
Unique identifier for the Item
_cidstring or null
Unique identifier for the Collection the Item belongs within
namestring or null
Name given to the Item
slugstring or null

URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.

Errors