Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Brand Id

Body

application/json
move_products_to
string | null

Brand that takes over the products and the live subscriptions of the brand you archive. It must be a brand of the same business, and it must not be archived. The primary brand (its brand id is the business id) is a valid target. Omit this field only when the brand holds no products and no live subscriptions.

Response

Archived Brand

archived_at
string<date-time>
required

Time the brand was archived.

brand_id
string
required

The archived brand.

collections_moved
integer<int64>
required

Count of product collections moved to the target brand.

Required range: x >= 0
products_moved
integer<int64>
required

Count of products moved to the target brand.

Required range: x >= 0
subscriptions_moved
integer<int64>
required

Count of live subscriptions moved to the target brand.

Required range: x >= 0
moved_to_brand_id
string | null

Brand that received the moved records. Null when no target was given.

Last modified on August 20, 2026