Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Partially update a product collection

Updates one or more fields of a product collection. Only the fields included in the request body are changed; everything left out keeps its current value.

patch
/product_collections/{id}/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters
idintegerRequired

The unique identifier of the product collection.

Body

The body of a product-collection partial update request. Only the fields included are changed.

namestring · max: 255Optional

The display name of the collection.

slugstring · max: 255Optional

A URL-friendly identifier.

is_activebooleanOptional

Whether the collection is active.

sort_optioninteger · nullableOptional

The identifier of a sort option.

collection_typestring · enumOptional

The membership model of a product collection.

Possible values:
Responses
200

The updated product collection.

application/json

A product collection — a named, reusable set of products used to target promotions and campaigns.

pkintegerRead-onlyOptional

The unique identifier of the collection.

uuidstring · uuidRead-onlyOptional

A stable unique identifier assigned on creation.

namestring · max: 255Optional

The display name of the collection.

slugstring · max: 255Optional

A URL-friendly identifier. Generated from name when left blank. Not required to be unique.

is_activebooleanOptional

Whether the collection is active. Defaults to true.

sort_optioninteger · nullableOptional

The identifier of a sort option applied when listing the collection's products.

collection_typestring · enumOptional

The membership model of a product collection.

Possible values:
created_datestring · date-timeRead-onlyOptional

When the collection was created.

modified_datestring · date-timeRead-onlyOptional

When the collection was last modified.

patch/product_collections/{id}/
PATCH /api/v1/remote/1/product_collections/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "is_active": false
}
{
  "pk": 12,
  "uuid": "1f7c9b2a-6d3e-4a1b-9c8d-2e5f7a0b1c3d",
  "name": "Summer Picks",
  "slug": "summer-picks",
  "is_active": true,
  "sort_option": null,
  "collection_type": "static",
  "created_date": "2026-06-01T10:00:00Z",
  "modified_date": "2026-06-01T10:00:00Z"
}

Last updated

Was this helpful?