Skip to main content
POST
Create batch call

Notes

  • Option 1 (Send now): set send_now=true.
  • Option 2 (Schedule call later): provide trigger_timestamp (send_now can be false or omitted).
  • status="draft" overrides execution.

Authorizations

X-API-KEY
string
header
required

API Key for MCP server and external service authentication

X-API-SECRET
string
header
required

API Secret for MCP server and external service authentication

Body

application/json
from_number
string
required

E.164 format

tasks
object[]
required
Required array length: 1 - 1000 elements
name
string
required
Maximum string length: 255
agent_id
string
required

agent_[uuid] format

send_now
boolean
default:false
required

Set true to send immediately. Use false/omit when scheduling with trigger_timestamp.

trigger_timestamp
integer<int64>

Unix timestamp (milliseconds). Required when scheduling (send_now false or omitted).

retry_config
object
quiet_hours
object
retry_rules
object[]
timezone
string

Valid timezone, default UTC

status
enum<string>
Available options:
draft,
scheduled,
sent
organization_id
string

Response

Batch call created successfully

batch_call_id
string
name
string
from_number
string
scheduled_timestamp
integer<int64>
total_task_count
integer
agent_id
string
organization_id
string
status
string
error
string | null
total
integer
sent
integer
picked_up
integer
completed
integer
timezone
string
last_sent_timestamp
integer<int64> | null
tasks_url
string
created_timestamp
integer<int64>
access_info
object
is_paused
boolean
paused_at
integer<int64> | null