> ## Documentation Index
> Fetch the complete documentation index at: https://docs.closient.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Merge a brand into this brand

> Merge the donor brand into this brand. **This is permanent**: the donor is deleted, its products move to this brand, and where both have a value for a profile field this brand's value is kept. Call `GET /brands/{id}/merge-preview` first to see exactly what will happen. Both brands must belong to the same organization. Requires the Owner or Manager role on that organization; a read-only key is refused with 403.



## OpenAPI

````yaml /openapi/openapi-brands.json post /brands/api/v1/brands/{id}/merge
openapi: 3.1.0
info:
  title: Brands API
  version: 1.0.0
  description: >
    Brand management: list, create, update, and manage brand profiles.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Those windows are per key. Your plan also caps each organization per hour,
    across every key,

    login and session acting for it: 100 requests on Free (or while a
    subscription is lapsed),

    10,000 on Business. While a subscription is lapsed, any method other than
    `GET`, `HEAD` and

    `OPTIONS` returns `403`.


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).


    ## Versioning and Deprecation


    Every response from an operation in this document carries
    `Closient-API-Version` (its `info.version`).

    An operation marked `deprecated` answers with `Deprecation: @<Unix seconds>`

    ([RFC 9745](https://www.rfc-editor.org/rfc/rfc9745)), `Sunset: <HTTP-date>`
    once a

    retirement date is set ([RFC 8594](https://www.rfc-editor.org/rfc/rfc8594)),
    and

    `Link` entries for `rel="deprecation"`, `rel="sunset"` and
    `rel="successor-version"`.

    After its sunset it answers `410 Gone` naming the replacement. Policy:

    https://docs.closient.com/api-versioning
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Brands
    description: Brand CRUD operations.
  - name: Brand Locator (Public)
    description: >-
      Unauthenticated endpoints that power the embeddable brand product-locator
      widget. Mounted under the `/public/` prefix so the widget CORS middleware
      opens CORS for them.
  - name: Brand GLNs
    description: The GS1 Global Location Numbers a brand uses, one of them primary.
  - name: Brand locations
    description: A brand's physical locations, at most one of them headquarters.
  - name: Brand editors
    description: >-
      People granted edit access to one brand. Signed-in Owner or Manager
      sessions only; API keys and OAuth tokens are refused.
  - name: Brand media intake
    description: >-
      The address consumers may send photos and video to directly, saved only
      with the brand's acknowledgment that Closient never receives that media.
  - name: Brand assets
    description: 'A brand''s media library: logos, banners, icons, documents and other files.'
  - name: Brand video pages
    description: >-
      Brand-styled landing pages built around a YouTube video, reused by
      resolver rules.
  - name: Brand story pages
    description: >-
      Brand-styled product story pages made of ordered content blocks, reused by
      resolver rules.
  - name: Brand merge
    description: >-
      Preview, then permanently merge one brand into another in the same
      organization.
  - name: Brand link pages
    description: >-
      Brand-styled link-in-bio pages made of ordered blocks, reused by resolver
      rules.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /brands/api/v1/brands/{id}/merge:
    post:
      tags:
        - Brand merge
      summary: Merge a brand into this brand
      description: >-
        Merge the donor brand into this brand. **This is permanent**: the donor
        is deleted, its products move to this brand, and where both have a value
        for a profile field this brand's value is kept. Call `GET
        /brands/{id}/merge-preview` first to see exactly what will happen. Both
        brands must belong to the same organization. Requires the Owner or
        Manager role on that organization; a read-only key is refused with 403.
      operationId: merge_brand
      parameters:
        - in: path
          name: id
          schema:
            description: URL-safe identifier of the brand that stays (the survivor).
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Id
            type: string
          required: true
          description: URL-safe identifier of the brand that stays (the survivor).
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandMergeIn'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandMergeOut'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: Unprocessable Content
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    BrandMergeIn:
      description: The brand to absorb.
      examples:
        - donor_id: 7mQ2vLkR9sTnWc4HbXyD3e
      properties:
        donor_id:
          description: >-
            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.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Donor Id
          type: string
      required:
        - donor_id
      title: BrandMergeIn
      type: object
    BrandMergeOut:
      description: The record of a completed merge.
      examples:
        - donor_id: 7mQ2vLkR9sTnWc4HbXyD3e
          donor_name: Acme Snack Co (Demo)
          field_collisions:
            - website
          merged_at: '2026-11-05T18:30:00Z'
          products_reassigned: 12
          survivor_id: SBjSX6xUJPPHQKUXBpYX2C
      properties:
        survivor_id:
          description: The brand that absorbed the donor and still exists.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Survivor Id
          type: string
        donor_id:
          anyOf:
            - description: >-
                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``).
              format: shortuuid
              maxLength: 22
              minLength: 22
              pattern: >-
                ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
              type: string
            - type: 'null'
          description: The deleted donor's identifier. It no longer resolves to a brand.
          title: Donor Id
        donor_name:
          description: The donor's name at the time of the merge.
          title: Donor Name
          type: string
        products_reassigned:
          description: Products moved from the donor to the survivor.
          title: Products Reassigned
          type: integer
        field_collisions:
          description: >-
            Profile fields where the donor's value was dropped in favour of the
            survivor's.
          items:
            type: string
          title: Field Collisions
          type: array
        merged_at:
          description: When the merge happened.
          format: date-time
          title: Merged At
          type: string
      required:
        - survivor_id
        - donor_id
        - donor_name
        - products_reassigned
        - field_collisions
        - merged_at
      title: BrandMergeOut
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.