Skip to main content
PUT
Update a collection
OAuth scope: offer_writeAPI keys have full access to this endpoint.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

collectionId
string
required

Body

application/json

Request to update a collection

name
string
Example:

"My collection"

description
string
Example:

"My collection description"

offerIds
string<uuid>[]

List of product IDs to set in the collection

Response

OK

id
string
required
Example:

"col_b1EVARkUTcCTSfspQaXr1Q"

shopId
string
required
Example:

"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"

name
string
required
Example:

"My collection"

slug
string
required
Example:

"my-collection"

description
string
required
Example:

"My collection description"

available
boolean
required
state
Archived · object
required

Archived collection state

offerIds
string<uuid>[]
required