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

# Update a brand asset

> Change an asset's type, title, description or primary flag. Send only the fields you are changing; `null` is refused with 422. A `logo`, `banner` or `icon` must be an image Closient accepts, read from the file's own bytes and never its name or declared type: JPEG, PNG, GIF, WebP or BMP, at most 20 MB and 8000 px on either side. Anything else is refused with 422 and a machine-readable `reason`, and nothing is stored. A `document` or `other` asset may be any file. Requires the Owner, Manager or Editor role; a read-only key is refused with 403.



## OpenAPI

````yaml /openapi/openapi-brands.json patch /brands/api/v1/brands/{id}/assets/{asset_id}
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}/assets/{asset_id}:
    patch:
      tags:
        - Brand assets
      summary: Update a brand asset
      description: >-
        Change an asset's type, title, description or primary flag. Send only
        the fields you are changing; `null` is refused with 422. A `logo`,
        `banner` or `icon` must be an image Closient accepts, read from the
        file's own bytes and never its name or declared type: JPEG, PNG, GIF,
        WebP or BMP, at most 20 MB and 8000 px on either side. Anything else is
        refused with 422 and a machine-readable `reason`, and nothing is stored.
        A `document` or `other` asset may be any file. Requires the Owner,
        Manager or Editor role; a read-only key is refused with 403.
      operationId: update_brand_asset
      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.
        - in: path
          name: asset_id
          schema:
            description: Identifier of the asset, as listed.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Asset Id
            type: string
          required: true
          description: Identifier of the asset, as listed.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandAssetUpdateIn'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandAssetOut'
        '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:
                anyOf:
                  - $ref: '#/components/schemas/BrandImageRejectedOut'
                  - $ref: '#/components/schemas/ErrorOut'
                title: Response
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    BrandAssetUpdateIn:
      description: >-
        Payload to change an asset's details: send only the fields you are
        changing. The file itself is replaced by

        uploading a new asset and deleting this one.
      examples:
        - is_primary: true
          title: Summer banner
      properties:
        asset_type:
          anyOf:
            - $ref: '#/components/schemas/BrandAssetTypeEnum'
            - type: 'null'
          description: >-
            Kind of asset: `logo`, `banner`, `icon`, `document` or `other`.
            Changing it to `logo`, `banner` or `icon` checks the stored file is
            an image Closient accepts, and refuses with 422 if it is not.
        title:
          anyOf:
            - maxLength: 255
              pattern: ^[^\x00]{0,255}$
              type: string
            - type: 'null'
          description: Title, up to 255 characters.
          title: Title
        description:
          anyOf:
            - maxLength: 5000
              pattern: ^[^\x00]{0,}$
              type: string
            - type: 'null'
          description: Description.
          title: Description
        is_primary:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            Make this the brand's primary asset of its type, demoting the
            current one.
          title: Is Primary
      title: BrandAssetUpdateIn
      type: object
    BrandAssetOut:
      description: One file in a brand's media library.
      examples:
        - asset_type: banner
          created: '2026-06-01T09:00:00Z'
          description: Homepage hero for the summer range.
          height: 400
          id: kL2mN4pQ6rS8tV3wX5yZ7a
          is_primary: true
          modified: '2026-06-19T14:30:00Z'
          title: Summer banner
          url: https://media.closient.com/brands/assets/summer-banner.png
          width: 1600
      properties:
        id:
          description: Identifier of the asset.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        asset_type:
          $ref: '#/components/schemas/BrandAssetTypeEnum'
          description: 'Kind of asset: `logo`, `banner`, `icon`, `document` or `other`.'
        title:
          description: Optional title; empty when none was given.
          title: Title
          type: string
        description:
          description: Optional description; empty when none was given.
          title: Description
          type: string
        is_primary:
          description: >-
            Whether this is the brand's primary asset of its type. Each type has
            at most one.
          title: Is Primary
          type: boolean
        url:
          description: URL the file can be downloaded from.
          title: Url
          type: string
        width:
          anyOf:
            - type: integer
            - type: 'null'
          description: Width in pixels of a logo, banner or icon; null for other types.
          title: Width
        height:
          anyOf:
            - type: integer
            - type: 'null'
          description: Height in pixels of a logo, banner or icon; null for other types.
          title: Height
        created:
          description: ISO-8601 upload timestamp.
          format: date-time
          title: Created
          type: string
        modified:
          description: ISO-8601 last-modified timestamp.
          format: date-time
          title: Modified
          type: string
      required:
        - id
        - asset_type
        - title
        - description
        - is_primary
        - url
        - width
        - height
        - created
        - modified
      title: BrandAssetOut
      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
    BrandImageRejectedOut:
      description: Why an uploaded brand image was refused.
      examples:
        - detail: unrecognized image bytes from uploaded file
          reason: invalid_content_type
      properties:
        reason:
          $ref: '#/components/schemas/ImageIngestionFailureReasonEnum'
          description: >-
            Machine-readable failure category: `oversized` (over 20 MB),
            `invalid_content_type` (not a JPEG, PNG, GIF, WebP or BMP, or does
            not decode) or `invalid_dimensions` (wider or taller than 8000 px).
        detail:
          description: Human-readable detail of what was wrong with the file.
          title: Detail
          type: string
      required:
        - reason
        - detail
      title: BrandImageRejectedOut
      type: object
    BrandAssetTypeEnum:
      description: Mirrors :class:`apps.brands.models.BrandAsset.AssetType`.
      enum:
        - logo
        - banner
        - icon
        - document
        - other
      title: BrandAssetTypeEnum
      type: string
    ImageIngestionFailureReasonEnum:
      description: |-
        Mirrors :class:`apps.products.models.ImageIngestionFailureReason`.

        Surfaced on a 422 from the vendor-URL image endpoint so a caller (or a
        human reading the response) knows whether a retry is worth attempting
        without parsing free text.
      enum:
        - download_error
        - timeout
        - http_error
        - oversized
        - invalid_content_type
        - invalid_dimensions
        - rejected_url
      title: ImageIngestionFailureReasonEnum
      type: string
  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.