PATCH /collections/{collection_id}/items/live

Update a single published item or multiple published items (up to 100) in a Collection

Items will only be updated in the primary locale, unless a cmsLocaleId is included in the request.

Required scope | CMS:write

Servers

Path parameters

Name Type Required Description
collection_id String Yes

Unique identifier for a Collection

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
skipInvalidFiles Boolean No

When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.

Default value: true

Request body fields

Name Type Required Description
items[] Array No
items[].id String Yes

Unique identifier for the Item

items[].isDraft Boolean No

Boolean determining if the Item is set to draft

items[].createdOn String No

The date the item was created

items[].fieldData Object No
items[].fieldData.name String No

Name of the Item

items[].fieldData.slug String No

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

items[].cmsLocaleId String No

Identifier for the locale of the CMS item

items[].isArchived Boolean No

Boolean determining if the Item is set to archived

items[].lastPublished String No

The date the item was last published

items[].lastUpdated String No

The date the item was last updated

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.