Update Brand Kit

Updates a brand kit’s name or role assignments: color roles, main logo, heading and body fonts. Omitted fields are unchanged and null is rejected. Each role object you send replaces the existing one in full; {} clears a role and it stays cleared. Role edits return 409 until the kit is completed; shared kits return 403.

PATCH /v3/brand-kits/{brand_kit_id}

Update Brand Kit

cURL

curl --request PATCH \
  --url https://api.heygen.com/v3/brand-kits/{brand_kit_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": null,
  "color_roles": null,
  "logo_roles": null,
  "font_roles": null
}
'

200

{
  "data": {
    "brand_kit_id": "<string>",
    "name": "<string>",
    "status": "loading",
    "colors": [
      "<string>"
    ],
    "color_roles": {
      "primary": "<string>",
      "secondary": "<string>",
      "tertiary": "<string>",
      "accent": "<string>"
    },
    "logos": [
      {
        "logo_id": "<string>",
        "name": "<string>",
        "url": "<string>"
      }
    ],
    "logo_roles": {
      "primary": "<string>"
    },
    "fonts": [
      {
        "font_id": "<string>",
        "name": "<string>"
      }
    ],
    "font_roles": {
      "title_text": {
        "font_id": "<string>",
        "weight": 123
      },
      "body_text": {
        "font_id": "<string>",
        "weight": 123
      }
    }
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

brand_kit_id · string · required

Unique brand kit identifier

Body

application/json

Request body for PATCH /v3/brand-kits/{brand_kit_id}.

Every field is optional and omitting one leaves it unchanged. Sending a role object with no fields inside it ({}) clears that role, and a cleared role stays cleared — nothing recomputes over a role the caller has deliberately emptied.

Clearing is an empty object rather than null, and null is rejected outright, so each intention has exactly one spelling. Generated clients serialise request bodies with exclude_none and drop a null before sending, so honouring null as "clear" would clear the role for a caller using raw HTTP and silently do nothing for a caller using our own SDK.

name · string

New display name for the brand kit, 1-256 characters. Leading and trailing whitespace is trimmed.

Required string length: 1 - 256

color_roles · Color Roles · object

Which color plays which part, as hex values. Replaces the stored assignment in full: a role you omit from this object is cleared, so send the roles you want to keep. Send {} to clear every color role.

Show child attributes

logo_roles · Logo Roles · object

Which logo is the brand's main one. Replaces the stored assignment in full, like color_roles, so omitting primary clears it. Send {} to clear the logo role.

Show child attributes

font_roles · Font Roles · object

Which font plays which typographic part. Replaces the stored assignment in full, like color_roles.

Show child attributes

Response

200

application/json

Successful response

data · BrandKitDetail · object

A single brand kit with its colors, logos and fonts.

A brand kit imported from a website is assembled in the background. While status is loading the collections and role fields are provisional and may be empty or incomplete; the import has finished contributing to them once status is completed. A kit whose import failed reports error and keeps whatever was assembled before the failure. A kit can still be edited in the HeyGen web app afterwards, so completed means the import is done, not that the kit is frozen.

Show child attributes