Update Collection Rules

Update a collection’s dynamic rules definition.

Method

PATCH /v1/collections/:id/rules

Path Parameters

id · string · required

Collection ID

Body Parameters

definition_json · object · required

Rules definition

definition_json · object

Hide properties

includeTags · string[]

Tags that must be present

excludeTags · string[]

Tags that must be absent

taxonomyNodeId · string

Taxonomy node identifier

destinationPlaceIds · string[]

Destination place IDs

price · object

Show price

min · number

Minimum price

max · number

Maximum price

currency · string

ISO currency

availability · object

Show availability

from · string

Start date (YYYY-MM-DD)

to · string

End date (YYYY-MM-DD)

capacity · object

Show capacity

min · number

Minimum capacity

rules · Array<Rule>

Show Rule

type · string

Rule type (e.g., tag, destination, price, date)

condition · string

Operator (e.g., equals, contains, gte, lte)

value · string

Value as string (numbers/dates are coerced)

manualProductIds · string[]

Explicit product IDs for manual collections

The definition is flexible and keys are optional. Avoid overlapping tags in includeTags and excludeTags. For manual collections, prefer manualProductIds; for smart collections, use rules and related filter keys.

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/rules \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "definition_json": {
      "includeTags": ["summer"],
      "excludeTags": ["archived"],
      "destinationPlaceIds": ["paris"],
      "price": { "min": 100, "max": 500, "currency": "EUR" },
      "availability": { "from": "2025-06-01", "to": "2025-08-31" },
      "rules": [ { "type": "tag", "condition": "equals", "value": "family" } ]
    }
  }'

200 OK

{ "ok": true }