Update Brand Glossary
Updates a brand glossary. Each field is replaced independently: a field you omit is left untouched, a field you send replaces that value in full, and an empty terms array removes every term. There is no way to add a single term — read the glossary, append to terms, and send the whole list back.
Renaming to a name another glossary in your workspace already uses returns 409.
A glossary’s translation rules are managed in the HeyGen web app and are never modified by this endpoint, so a glossary edited there keeps them through an update made here.
Authorizations
HeyGen API key. Obtain from your HeyGen dashboard.
Path Parameters
Unique brand glossary identifier
Body
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.
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.
1 - 64Replacement term list. Omit to leave the existing terms untouched, or pass an empty array to remove them all.
Response
Successful response
A single brand glossary with its full term list (GET /v3/brand-glossaries/{id}).

