API Reference
Release NotesProof ScheduleĀ®UI LibrariesClient LibrariesBlog

Create collection

post
https://ac.cnstrc.com/v1/collections

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

Create a collection.

Query Params
string
required
length between 1 and 100

The key of the index to use.

string
length between 1 and 100

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

string
length between 1 and 100

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

Body Params
string
required
length between 1 and 100

ID of the collection, must be unique.

string
required
length between 1 and 100

Name of the collection to be displayed to end users.

object | Encoded JSON string

Filter expression associated with this collection.

data
object

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

boolean
Defaults to false

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

matches
array of objects
length ā‰¤ 50

A list of terms associated with this collection for matching purposes.

Matches
date-time

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

date-time

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

string
length between 1 and 100

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.

Responses

400

Validation Error

401

Credentials are not passed or action is forbidden.

403

The supplied token does not have the required permissions.

409

Conflict

429

Rate limit breached

Updated 26 days ago

Language
Credentials
:
LoadingLoadingā€¦
Response
Choose an example:
application/json

Updated 26 days ago