POST
/
create-batch-call

Authorizations

Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Body

application/json
from_number
string
required

The number you own in E.164 format. Must be a number purchased from Retell or imported to Retell.

tasks
object[]
required

A list of individual call tasks to be executed as part of the batch call. Each task represents a single outbound call and includes details such as the recipient's phone number and optional dynamic variables to personalize the call content.

name
string

The name of the batch call. Only used for your own reference.

trigger_timestamp
number

The scheduled time for sending the batch call, represented as a Unix timestamp in milliseconds. If omitted, the call will be sent immediately.

Response

201 - application/json
batch_call_id
string
required

Unique id of the batch call.

from_number
string
required
name
string
required
scheduled_timestamp
number
required
total_task_count
number
required

Number of tasks within the batch call