Skip to main content
POST
Start outbound batch

Authorizations

X-API-Key
string
header
required

API key issued for the workspace.

Body

application/json
callerId
string
required

Phone number presented as caller ID.

recipients
object[]
required
Required array length: 1 - 1000 elements
agentId
string

Optional agent override. When omitted, the phone number's outbound agent is used.

maxConcurrency
integer

Maximum calls processed concurrently.

scheduledAt
string<date-time> | null
scheduleStart
string

Zero-padded HH:MM time in the selected timezone.

Pattern: ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$
Example:

"09:30"

scheduleEnd
string

Zero-padded HH:MM time in the selected timezone.

Pattern: ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$
Example:

"09:30"

timezone
string

IANA time zone used for the schedule.

Response

Batch accepted

success
boolean
required
Example:

true

data
object
required