Skip to main content
POST
cURL

Request body example

Use phone_numbers to add recipients to a campaign. Each phone number must be in E.164 format. Use call_variables to pass per-recipient context to the agent.
You can add up to 5000 phone numbers in one request. Each recipient’s call_variables object can be up to 4 KiB.

Authorizations

X-API-Key
string
header
required

Your unique organization API key. Required on all requests.

Path Parameters

agent_id
string<uuid>
required

The UUID of the AI agent that owns the campaign.

campaign_id
string<uuid>
required

The UUID of the campaign.

Body

application/json
phone_numbers
object[]
required
Required array length: 1 - 5000 elements

Response

Campaign calls scheduled successfully

message
string
required
data
object
required