---
title: "Update a collection"
method: PATCH
path: "/v1/messaging/commerce/collections/{collectionId}"
tags: ["Commerce"]
---

# Update a collection

`PATCH /v1/messaging/commerce/collections/{collectionId}`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/commerce/collections/{collectionId}`
- Auth: HTTP bearer

Partial update; at least one field besides accountId is required. Change membership with POST /v1/commerce/collections/{collectionId}/products.

**Billing:** Request; paid actions are priced in credits (see GET /v1/messaging/prices) · **Rate limit:** 60/min

## Path parameters

- `collectionId` string, required: Platform-native collection id.

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Request body

- object
  - `seo` object
    - `title` string
    - `description` string
  - `image` object
    - `url` string, uri, required
    - `altText` string
  - `title` string
  - `handle` string
  - `accountId` string, required
  - `sortOrder` 'manual' | 'best_selling' | 'alpha_asc' | 'alpha_desc' | 'price_asc' | 'price_desc' | 'created' | 'created_desc' | 'most_relevant'
  - `descriptionHtml` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `collection` object: A product collection on a connected store.
      - `id` string: Platform-native collection id.
      - `seo` object
        - `title` string, nullable
        - `description` string, nullable
      - `image` object, nullable
        - `id` string, nullable: Media id, used to reorder or remove images. Null for collection images.
        - `url` string
        - `altText` string, nullable
      - `title` string
      - `handle` string, nullable
      - `platform` 'shopify' | 'woocommerce'
      - `accountId` string
      - `sortOrder` 'manual' | 'best_selling' | 'alpha_asc' | 'alpha_desc' | 'price_asc' | 'price_desc' | 'created' | 'created_desc' | 'most_relevant'
      - `updatedAt` string, date-time, nullable
      - `platformData` object, nullable
      - `productCount` integer, nullable: Updates a few seconds after a membership change.
      - `descriptionHtml` string, nullable
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)