HEheygen
Models

Update an Audio Voice

Changed on

Renames a voice that your workspace owns, instant or professional. Today name is the only field you can change. The name follows the same rules as when the voice was created: spaces at the start and end are removed, and an instant voice name can have 1 to 64 characters, a professional voice name 1 to 256. Returns the updated voice, in the same shape as GET /v3/models/audio/voices/{voice_id}. The HeyGen app also shows the new name. It may cut a name longer than 64 characters. A professional voice can be renamed in any status. An instant voice cannot be renamed while its status is PENDING, which lasts a few seconds after it is created: this returns 409 voice_not_ready, so wait a few seconds and try again. A public voice, a deleted voice, or a voice from another workspace returns 404 voice_not_found. A workspace member who cannot edit the voice in the HeyGen app is refused as DELETE refuses them: 403 resource_access_denied, or 404 resource_not_found when the member has no access to the voice at all.

patch/v3/models/audio/voices/{voice_id}

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/models/audio/voices/{voice_id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

voice_idstring required

Unique voice identifier

Request body

namestring required

New display name of the voice. Spaces at the start and end are removed. The limits are the same as when the voice was created: 1 to 64 characters for an instant voice, 1 to 256 for a professional voice.

Example request

{
  "name": "Support Narrator"
}

Response

Successful response

Changes