Skip to main content
POST
/
v3
/
avatars
/
{group_id}
/
consent
Create avatar consent
curl --request POST \
  --url https://api.heygen.com/v3/avatars/{group_id}/consent \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reroute_url": "<string>"
}
'
{}

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 POST /v3/avatars/{group_id}/consent.

​
reroute_url
string | null

Callback URL where the user is redirected after completing consent. Defaults to HeyGen's consent completion page.

Response

Successful response

​
data
CreateAvatarConsentResponse · object

Response body for POST /v3/avatars/{group_id}/consent.