Skip to main content
PATCH
Update Avatar Group

Authorizations

x-api-key
string
header
required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

group_id
string
required

Unique avatar group identifier

Body

application/json

Request body for PATCH /v3/avatars/{group_id}.

default_voice_id
string | null

Voice ID to set as the avatar's default voice, replacing the current one. The voice is also linked to the avatar group if it was not already. Accepts any voice available to your workspace, including imported voice clones. Only supported for avatars you own.

Maximum string length: 255
Example:

"1bd001e7e50f421d891986aad5c8bbd2"

Response

Successful response

data
AvatarGroupItem · object

A single avatar group in the list response.

Groups are containers for looks (outfits/styles). To determine avatar type and engine compatibility, fetch the looks via GET /v3/avatars/looks.