CMSCollection ItemsStaged Items

Create Localized Collection Item(s)

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

  • This endpoint can create up to 100 items in a request.
  • If the cmsLocaleIds parameter is not included in the request, an item 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.

Query parameters

skipInvalidFilesbooleanOptionalDefaults to true
If true, invalid file uploads will be skipped and the request will still be successful. If false, the request will fail if any file uploads are invalid.

Request

This endpoint expects an object.
fieldDataobject or list of objectsRequired
idstringOptional
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 false
Indicates whether the item is in draft state.

Response

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

Errors