Update Brand Glossary

post

https://api.heygen.com/v1/brand_voice/{brand_voice_id}

Updates an existing brand glossary with specified changes.

Path Params

brand_voice_id

string

required

Unique identifier of the brand glossary to update. Can be retrieved from List Brand Voices endpoint.

Body Params

name

string

New name for the brand glossary.

blacklist

array of strings

List of words or phrases that should not be translated or modified. Typically includes brand names, proper nouns, or other protected terms (e.g., "HeyGen", "John Smith").

blacklist

whitelist

array of strings

List of word pairs where each pair defines a source word and its enforced translation or form (e.g., ["Machine Learning", "ML"], ["Artificial Intelligence", "AI"])

whitelist

tones

array of strings

List of tone keywords to influence how the voice speaks or how the translations are rendered (e.g., "professional", "friendly").

tones

vocabulary

array of strings

List of word pairs that define custom pronunciations or phonetic spellings. Each pair includes the original word and its pronunciation. (e.g., ["HeyGen", "Hey-jen"], ["GIF", "JIF"])

vocabulary

tone

string

Overall style, attribute, or manner of speech for the glossary. Guides how text is spoken or translated.

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Brand glossary updated successfully - Expand to view the detailed response schema.

400Invalid parameters:whitelist is invalid.vocabulary is invalid.