Skip to main content
POST
Post Agent Hold Audio

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

agent_id
string
required

The id of an agent. This is returned on agent creation.

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

Body

multipart/form-data
hold_audio_file
file
required

MP3 or WAV audio file to play while callers wait in the queue.

Response

Successful Response

agent_id
string
required
hold_audio
AgentHoldAudioConfig · object
required

Custom hold audio played on loop to callers waiting in the agent's queue.

Set by uploading a file through the agent hold-audio endpoint. Values sent in agent create or update requests are ignored.