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.
Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.
The unique identifier of the product collection.
The body of a product-collection partial update request. Only the fields included are changed.
The display name of the collection.
A URL-friendly identifier.
Whether the collection is active.
The identifier of a sort option.
The membership model of a product collection.
The updated product collection.
A product collection — a named, reusable set of products used to target promotions and campaigns.
The unique identifier of the collection.
A stable unique identifier assigned on creation.
The display name of the collection.
A URL-friendly identifier. Generated from name when left blank. Not required to be unique.
Whether the collection is active. Defaults to true.
The identifier of a sort option applied when listing the collection's products.
The membership model of a product collection.
When the collection was created.
When the collection was last modified.
The request contains invalid or missing data.
Authentication credentials were not provided or are invalid.
The authenticated user does not have administrator privileges.
The requested product collection does not exist.
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?

