Replace collection

put

https://ac.cnstrc.com/v1/collections/{collection_id}

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

Replace collection.

Path Params

collection_id

string

required

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

section

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.

display_name

string

required

length between 1 and 100

Name of the collection to be displayed to end users.

filter_expression

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.

discoverable

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

start_time

date-time

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

end_time

date-time

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

parent_id

string

length between 1 and 100

ID of the parent collection associated with this collection.

Responses

400

Validation Error

401

Credentials are not passed or action is forbidden.

403

The supplied token does not have the required permissions.

404

Not Found

409

Conflict

429

Rate limit breached

👋 Welcome to Constructor's new and improved documentation

200OK