post https://api.heygen.com/v1/brand_voice/
Updates an existing brand voice with specified changes. Only the fields that need to be modified should be included in the request body.
Request Body
All fields in the request body are optional. Only include the fields you want to update.
| Field | Type | Description |
|---|---|---|
| name | string | New name for the brand voice |
| blacklist | array[string] | List of words that should not be translated (e.g., brand names, person names) |
| whitelist | array[tuple[string, string]] | List of word pairs for forced translations |
| tones | array[string] | List of tone keywords to influence the voice |
| vocabulary | array[tuple[string, string]] | List of word pairs for pronunciation guidance |
| tone | string | Overall tone description |
Examples
All fields are optional in the POST request, so you only need to include the fields you want to update.
Minimal Update Request
{
"vocabulary": [["HeyGen", "Hey-jen"]]
}
Full Update Request
{
"name": "Brand Voice Name",
"blacklist": ["HeyGen", "John Smith"], // Don't translate these words
"whitelist": [["AI", "artificial intelligence"]], // Force translations
"tones": ["professional", "friendly"], // Tone keywords
"vocabulary": [["HeyGen", "Hey-jen"]], // Pronunciation pairs
"tone": "communicate with clarity and enthusiasm, avoiding overly technical jargon when possible."
}