> ## 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.

# Add a brand location

> Add a physical location to the brand. Marking it the headquarters clears the flag on the previous one. Requires the Owner, Manager or Editor role on the organization that owns the brand; a read-only key is refused with 403.



## OpenAPI

````yaml /openapi/openapi-brands.json post /brands/api/v1/brands/{id}/locations
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     |


    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).
  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 (C-1803). 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 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}/locations:
    post:
      tags:
        - Brand locations
      summary: Add a brand location
      description: >-
        Add a physical location to the brand. Marking it the headquarters clears
        the flag on the previous one. Requires the Owner, Manager or Editor role
        on the organization that owns the brand; a read-only key is refused with
        403.
      operationId: create_brand_location
      parameters:
        - in: path
          name: id
          schema:
            description: URL-safe brand identifier.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Id
            type: string
          required: true
          description: URL-safe brand identifier.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandLocationCreateIn'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandLocationOut'
        '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:
    BrandLocationCreateIn:
      description: >-
        Payload to add a location to a brand. The same fields as the dashboard's
        location form.
      examples:
        - address: 100 Main Street
          city: Portland
          country: United States
          is_headquarters: true
          name: Head office
          postal_code: '97201'
          state_province: OR
      properties:
        name:
          description: Name of the location (1 to 255 characters).
          maxLength: 255
          minLength: 1
          pattern: ^[^\x00]{1,255}$
          title: Name
          type: string
        address:
          description: Street address (at least 1 character).
          maxLength: 2000
          minLength: 1
          pattern: ^[^\x00]{1,}$
          title: Address
          type: string
        city:
          description: City (1 to 100 characters).
          maxLength: 100
          minLength: 1
          pattern: ^[^\x00]{1,100}$
          title: City
          type: string
        state_province:
          default: ''
          description: State or province, up to 100 characters; empty when not applicable.
          maxLength: 100
          pattern: ^[^\x00]{0,100}$
          title: State Province
          type: string
        postal_code:
          description: Postal or ZIP code (1 to 20 characters).
          maxLength: 20
          minLength: 1
          pattern: ^[^\x00]{1,20}$
          title: Postal Code
          type: string
        country:
          description: Country (1 to 100 characters).
          maxLength: 100
          minLength: 1
          pattern: ^[^\x00]{1,100}$
          title: Country
          type: string
        is_headquarters:
          default: false
          description: >-
            Make this the brand's headquarters, clearing the flag on any other
            location.
          title: Is Headquarters
          type: boolean
      required:
        - name
        - address
        - city
        - postal_code
        - country
      title: BrandLocationCreateIn
      type: object
    BrandLocationOut:
      description: One physical location of a brand.
      examples:
        - address: 100 Main Street
          city: Portland
          country: United States
          created: '2026-06-01T09:00:00Z'
          id: cD4eF6gH8jK2mN3pQ5rS7t
          is_headquarters: true
          modified: '2026-06-19T14:30:00Z'
          name: Head office
          postal_code: '97201'
          state_province: OR
      properties:
        id:
          description: Identifier of the location.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        name:
          description: Name of the location, such as 'Head office' or 'Bakery'.
          title: Name
          type: string
        address:
          description: Street address.
          title: Address
          type: string
        city:
          description: City.
          title: City
          type: string
        state_province:
          description: State or province; empty when not applicable.
          title: State Province
          type: string
        postal_code:
          description: Postal or ZIP code.
          title: Postal Code
          type: string
        country:
          description: Country, as the brand writes it.
          title: Country
          type: string
        is_headquarters:
          description: Whether this is the brand's headquarters. At most one is.
          title: Is Headquarters
          type: boolean
        created:
          description: ISO-8601 creation timestamp.
          format: date-time
          title: Created
          type: string
        modified:
          description: ISO-8601 last-modified timestamp.
          format: date-time
          title: Modified
          type: string
      required:
        - id
        - name
        - address
        - city
        - state_province
        - postal_code
        - country
        - is_headquarters
        - created
        - modified
      title: BrandLocationOut
      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.