Update Collection

Update collection properties by ID.

Method

PATCH /v1/collections/:id

Path Parameters

id · string · required

Collection ID

Body Parameters

base · object

Partial base updates

Hide updatable properties

name · string

Display name (when not using translation update)

slug · string

Slug (nullable)

status · string

active | draft | archived

sortStrategy · string

manual | newest | price_asc | price_desc | random | custom (alias: sort_strategy)

definition · object

Rules/definition (alias: rules)

translation · object

Partial translation updates (requires locale)

Hide updatable properties

locale · string · required

Locale code

name · string

Localized name

slug · string

Localized slug (nullable)

description · string

Localized description (nullable)

Headers

Authorization · string · required

Bearer token (e.g. Authorization: Bearer YOUR_API_KEY)

content-type · string

application/json

cURL

curl -X PATCH https://api.voyantcloud.com/v1/collections/col_123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{ "base": { "status": "active", "sort_strategy": "manual" } }'

200 OK

{
  "id": "col_123",
  "status": "active"
}