Skip to main content
PATCH
Update Brand Glossary

Authorizations

x-api-key
string
header
required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

brand_glossary_id
string
required

Unique brand glossary identifier

Body

application/json

Request body for PATCH /v3/brand-glossaries/{brand_glossary_id}.

Each field is replaced independently: a field you omit is left untouched, a field you send replaces that value in full, and an empty array clears the term list. There is no way to add a single term — read the glossary, append to terms, and send the whole list back.

name
string

New display name. Surrounding whitespace is removed, and the trimmed name must be 1-64 characters and unique within your workspace, compared without regard to case. Omit to keep the current name.

Required string length: 1 - 64
terms
BrandGlossaryTerm · object[]

Replacement term list. Omit to leave the existing terms untouched, or pass an empty array to remove them all.

Response

Successful response

data
BrandGlossaryDetail · object

A single brand glossary with its full term list (GET /v3/brand-glossaries/{id}).