Skip to main content
PUT
https://jwhite.tail8bf327.ts.net
/
api
/
v1
/
avatars
/
{id}
Update Avatar
curl --request PUT \
  --url https://jwhite.tail8bf327.ts.net/api/v1/avatars/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "voice_id": "<string>",
  "is_favorite": true
}
'
{
  "success": true
}

​
Authentication

Requires an API key in the x-api-key header. 
x-api-key: ah_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Parameters

​
id
integer
required
The ID of the avatar to update

​
Request Body

All fields are optional. Only include the fields you want to update.
​
name
string
Avatar name
​
url
string
URL to avatar image or video file
​
voice_id
string
Voice ID to associate with this avatar (set to null to remove)
​
is_favorite
boolean
Whether this avatar is marked as a favorite

​
Request

PUT https://jwhite.tail8bf327.ts.net/api/v1/avatars/10
x-api-key: ah_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

{
  "name": "Updated Professional Avatar",
  "voice_id": "EXAVITQu4vr4xnSDxMaL",
  "is_favorite": true
}

​
Response

{
  "success": true
}

{
  "error": "Avatar not found"
}

{
  "error": "No fields to update"
}

​
Notes

  • Only the fields included in the request body will be updated
  • The updated_at timestamp is automatically updated
  • At least one field must be provided for update (name, url, voice_id, or is_favorite)
  • You must own the avatar to update it (user_id must match authenticated user)
  • Changes to avatars take effect immediately for agents using them
  • Updating the voice_id will change the voice for all agents using this avatar

​
Error Responses

For information about error responses and status codes, see Error Responses.

​
Common Errors for This Endpoint

  • 400 Bad Request - No fields to update
  • 401 Unauthorized - Invalid or missing API key
  • 404 Not Found - Avatar not found or not owned by user
  • 500 Internal Server Error - Server error