Brand

Update Brand Kit

Updates a brand kit’s name or its role assignments — which color plays which part, which logo is the main one, and which font is used for headings and body text. A field you omit is left unchanged.

Creation assigns these roles automatically, with no human in the loop, so this is how a caller corrects them.

Each role object is replaced in full rather than merged: send the roles you want to keep, since a role you leave out of the object is cleared. Send an empty object to clear a role entirely. A cleared role stays cleared and is not recomputed later. Sending null for any field is rejected: omit it to leave it unchanged.

Role edits require an assembled kit and return 409 while status is ‘loading’ or ‘error’. Renaming is allowed at any time. Editing the colors themselves is not supported here yet.

A brand kit shared into your workspace by another workspace is readable but not editable, and returns 403.

PATCH

brand-kits

{brand_kit_id}

Update Brand Kit

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
}
'

import requests

url = "https://api.heygen.com/v3/brand-kits/{brand_kit_id}"

payload = {
    "name": None,
    "color_roles": None,
    "logo_roles": None,
    "font_roles": None
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: null, color_roles: null, logo_roles: null, font_roles: null})
};

fetch('https://api.heygen.com/v3/brand-kits/{brand_kit_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/brand-kits/{brand_kit_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => null,
    'color_roles' => null,
    'logo_roles' => null,
    'font_roles' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heygen.com/v3/brand-kits/{brand_kit_id}"

	payload := strings.NewReader("{\n  \"name\": null,\n  \"color_roles\": null,\n  \"logo_roles\": null,\n  \"font_roles\": null\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.heygen.com/v3/brand-kits/{brand_kit_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": null,\n  \"color_roles\": null,\n  \"logo_roles\": null,\n  \"font_roles\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/brand-kits/{brand_kit_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": null,\n  \"color_roles\": null,\n  \"logo_roles\": null,\n  \"font_roles\": null\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "brand_kit_id": "<string>",
    "name": "<string>",
    "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
      }
    }
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "Provide at least one field to update.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or expired API key. Verify your x-api-key header.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "resource_access_denied",
    "message": "This brand kit is shared with your workspace and can only be edited by the workspace that owns it.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "resource_not_found",
    "message": "Brand kit not found.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "brand_kit_not_ready",
    "message": "This brand kit is still being assembled (status 'loading'). Roles can only be edited once it is 'completed'.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Retry after the duration specified in the Retry-After header.",
    "param": null,
    "doc_url": null
  }
}

Authorizations

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

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

⌘I

Update Brand Kit

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
}
'

import requests

url = "https://api.heygen.com/v3/brand-kits/{brand_kit_id}"

payload = {
    "name": None,
    "color_roles": None,
    "logo_roles": None,
    "font_roles": None
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: null, color_roles: null, logo_roles: null, font_roles: null})
};

fetch('https://api.heygen.com/v3/brand-kits/{brand_kit_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/brand-kits/{brand_kit_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => null,
    'color_roles' => null,
    'logo_roles' => null,
    'font_roles' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heygen.com/v3/brand-kits/{brand_kit_id}"

	payload := strings.NewReader("{\n  \"name\": null,\n  \"color_roles\": null,\n  \"logo_roles\": null,\n  \"font_roles\": null\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.heygen.com/v3/brand-kits/{brand_kit_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": null,\n  \"color_roles\": null,\n  \"logo_roles\": null,\n  \"font_roles\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/brand-kits/{brand_kit_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": null,\n  \"color_roles\": null,\n  \"logo_roles\": null,\n  \"font_roles\": null\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "brand_kit_id": "<string>",
    "name": "<string>",
    "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
      }
    }
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "Provide at least one field to update.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or expired API key. Verify your x-api-key header.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "resource_access_denied",
    "message": "This brand kit is shared with your workspace and can only be edited by the workspace that owns it.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "resource_not_found",
    "message": "Brand kit not found.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "brand_kit_not_ready",
    "message": "This brand kit is still being assembled (status 'loading'). Roles can only be edited once it is 'completed'.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Retry after the duration specified in the Retry-After header.",
    "param": null,
    "doc_url": null
  }
}

Video Agent

Brand

Avatars

Audio

Voices

Videos

Templates

Video Translate

Lipsync

HyperFrames

User

Webhooks

Assets

AI Clipping

Filler Word Removal

Batches

Video Translation Batches

Lipsync Batches

Asset Batches

Update Brand Kit

Authorizations

Path Parameters

Body

Response