Skip to main content
PUT
Update Collection

Update Collection

Updates an existing collection. Only provided fields are updated. Requires the write_products scope.

Request

Path Parameters

string
required
The unique collection ID to update

Body Parameters

All parameters are optional. Only the four fields below are applied; any other field in the request body is accepted but ignored.
string
The collection title
string
Collection description (supports HTML). This is the field that updates the collection body — it is returned as body_html (and description) on read.
string
URL-safe handle
string
URL of the collection featured image. Pass null to remove.

Response

The response is a bare object keyed by collection containing the updated collection object (the same shape returned by the read endpoints). There is no { status, data } envelope.
object
The updated collection object

Example Response

Errors

Errors are returned as a standard { "errors": { "base": ["..."] } } body with the corresponding HTTP status code.