Skip to main content
POST
/
v1
/
external
/
campaigns
/
{agent_id}
/
{campaign_id}
/
scheduled-calls
cURL
curl --request POST \
  --url https://api.samora.ai/v1/external/campaigns/{agent_id}/{campaign_id}/scheduled-calls \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "phone_numbers": [
    {
      "to_number": "+919876543210",
      "call_variables": {
        "name": "Aarav Sharma",
        "customer_id": "CUST-001",
        "city": "Mumbai"
      }
    },
    {
      "to_number": "+919812345678",
      "call_variables": {
        "name": "Priya Mehta",
        "customer_id": "CUST-002",
        "city": "Delhi"
      }
    }
  ]
}
'
{
  "message": "<string>",
  "data": {
    "scheduled_call_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}

​
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. 
{
	"phone_numbers": [
		{
			"to_number": "+919876543210",
			"call_variables": {
				"name": "Aarav Sharma",
				"customer_id": "CUST-001",
				"city": "Mumbai"
			}
		},
		{
			"to_number": "+919812345678",
			"call_variables": {
				"name": "Priya Mehta",
				"customer_id": "CUST-002",
				"city": "Delhi"
			}
		}
	]
}
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