POST
/
hold
curl --request POST \
  --url https://api.bland.ai/hold \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "phone_number": "<string>",
  "hold_connect": "<string>",
  "task": "<string>"
}'
{
  "status": "success",
  "call_id": "9d404c1b-6a23-4426-953a-a52c392ff8f1"
}

Headers

authorization
string
required

Your API key for authentication.

Body

phone_number
string
required

This is the phone number of the person or company you want to call. - International numbers: must include the country code and may not include additional formatting (like parentheses and dashes). E.g. ‘+447700900077’. - U.S. numbers: may include formatting, but we recommend stripping all additional characters.

hold_connect
string
required

Once the AI detects a human has answered the call, it will call this number. Must follow the same formatting as phone_number

task
string

By default, the AI will wait on hold, then call you when a human answers. If you want the AI to first ask the other human a few questions, or want to give it special rules about when to patch you into the phone call, provide those instructions here.

Response

status
string

Can be success or error.

call_id
string

A unique identifier for the call (present only if status is success)