HEheygen
Brand

Update Brand Glossary

Changed on

Updates a brand glossary. A field you omit is left untouched, a list you send replaces the existing list in full across all languages, and an empty array removes every entry. Read the glossary and preserve every entry's pronunciation_language or target_language when sending an edited list; omitting a language field means all languages. A duplicate name or term/rule-type/language combination returns 409. A concurrent-edit conflict also returns 409 without saving the update; fetch the latest glossary and reapply your changes. Clients do not supply revisions. Tone settings are never modified by this endpoint. Temporary access-evaluation failures return 503; retry the request.

patch/v3/brand-glossaries/{brand_glossary_id}

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/brand-glossaries/{brand_glossary_id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

brand_glossary_idstring required

Unique brand glossary identifier

Request body

namestring

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.

Response

Successful response

Changes