Create collection

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: collections(w).

Create a collection.

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

sectionstring

The section of the index to use. Defaults to Products.

Example:Products

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Request body

idstring required

ID of the collection, must be unique.

display_namestring required

Name of the collection to be displayed to end users.

dataobject

Object containing additional data, that should be attached to this collection. The maximum size of data object is limited to 200kb.

discoverableboolean

When true, the collection is discoverable in autocomplete and search.

start_timestring date-time

ISO-8601 string in UTC defining start time when the collection becomes active. Any specified timezone will be omitted.

end_timestring date-time

ISO-8601 string in UTC defining start time when the collection becomes inactive. Any specified timezone will be omitted.

overridden_collection_idstring

The ID of the base collection that this collection overrides. An overriding collection temporarily replaces the content of a base collection during a scheduled time window. Only base collections (collections with overridden_collection_id set to null) can be overridden.

Example request

{
  "id": "summer-sale",
  "display_name": "Summer Sale",
  "data": {
    "key": "value"
  },
  "matches": [
    {
      "pattern": "summer sale"
    }
  ],
  "start_time": "2025-12-10T10:00:00",
  "end_time": "2025-12-31T23:59:59",
  "overridden_collection_id": "overridden-collection"
}

Response

Created