Skip to main content
POST
Merge a brand into this brand

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<shortuuid>
required

URL-safe identifier of the brand that stays (the survivor).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

The brand to absorb.

donor_id
string<shortuuid>
required

URL-safe identifier of the brand to absorb (the donor). It is deleted by the merge. It must belong to the same organization as the survivor.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

The record of a completed merge.

survivor_id
string<shortuuid>
required

The brand that absorbed the donor and still exists.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
donor_id
string<shortuuid> | null
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
donor_name
string
required

The donor's name at the time of the merge.

products_reassigned
integer
required

Products moved from the donor to the survivor.

field_collisions
string[]
required

Profile fields where the donor's value was dropped in favour of the survivor's.

merged_at
string<date-time>
required

When the merge happened.