CMSCollection ItemsStaged Items

Create Localized Collection Item(s)

Create an item or multiple items in a CMS Collection across multiple corresponding locales.

Notes:

  • This endpoint can create up to 100 items in a request.
  • If the cmsLocaleIds parameter is undefined or empty and localization is enabled, items will only be created in the primary locale.

Required scope | CMS:write

Path parameters

collection_idstringRequiredformat: "objectid"
Unique identifier for a Collection

Headers

AuthorizationstringRequired

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

Request

Details of the item to create
idstringRequired
Unique identifier for the Item
cmsLocaleIdslist of stringsOptional
Array of identifiers for the locales where the item will be created
lastPublishedstringOptionalformat: "date-string"
The date and time when the item was last published.
lastUpdatedstringOptionalformat: "date-string"
The date and time when the item was last updated.
createdOnstringOptionalformat: "date-string"
The date and time when the item was created.
isArchivedbooleanOptionalDefaults to false
Indicates whether the item is archived.
isDraftbooleanOptionalDefaults to true
Indicates whether the item is in draft state.
fieldDataobject or list of objectsOptional

Response

Request was successful
idstring
Unique identifier for the Item
cmsLocaleIdslist of strings or null
Array of identifiers for the locales where the item will be created
lastPublishedstring or nullformat: "date-string"
The date the item was last published
lastUpdatedstring or nullformat: "date-string"
The date the item was last updated
createdOnstring or nullformat: "date-string"
The date the item was created
isArchivedboolean or nullDefaults to false
Boolean determining if the Item is set to archived
isDraftboolean or nullDefaults to true
Boolean determining if the Item is set to draft
fieldDataobject or null

Errors