Create Batch Call
curl --request POST \
--url https://api.truedy.ai/api/public/v1/batch-calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "March follow-up campaign",
"agent_id": "agt_123e4567-e89b-12d3-a456-426614174000",
"phone_number_ids": [
"num_11111111-1111-1111-1111-111111111111"
],
"phone_rotation_strategy": "random",
"contact_source": "csv",
"contact_folder_id": "<string>",
"contact_ids": [
"ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
],
"contacts": [
{
"email": "ada@example.com",
"first_name": "Ada",
"last_name": "Lovelace",
"phone_number": "+15551234567"
}
],
"schedule_type": "immediate",
"scheduled_at": "2026-03-20T09:00:00Z",
"timezone": "America/New_York",
"start_time": "09:00",
"end_time": "17:30",
"working_days": [
1,
2,
3,
4,
5
],
"max_concurrent_calls": 10,
"max_calls_per_day": 500,
"retry_failed": false,
"max_retry_attempts": 2
}
'import requests
url = "https://api.truedy.ai/api/public/v1/batch-calls"
payload = {
"name": "March follow-up campaign",
"agent_id": "agt_123e4567-e89b-12d3-a456-426614174000",
"phone_number_ids": ["num_11111111-1111-1111-1111-111111111111"],
"phone_rotation_strategy": "random",
"contact_source": "csv",
"contact_folder_id": "<string>",
"contact_ids": ["ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"],
"contacts": [
{
"email": "ada@example.com",
"first_name": "Ada",
"last_name": "Lovelace",
"phone_number": "+15551234567"
}
],
"schedule_type": "immediate",
"scheduled_at": "2026-03-20T09:00:00Z",
"timezone": "America/New_York",
"start_time": "09:00",
"end_time": "17:30",
"working_days": [1, 2, 3, 4, 5],
"max_concurrent_calls": 10,
"max_calls_per_day": 500,
"retry_failed": False,
"max_retry_attempts": 2
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'March follow-up campaign',
agent_id: 'agt_123e4567-e89b-12d3-a456-426614174000',
phone_number_ids: ['num_11111111-1111-1111-1111-111111111111'],
phone_rotation_strategy: 'random',
contact_source: 'csv',
contact_folder_id: '<string>',
contact_ids: ['ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'],
contacts: [
{
email: 'ada@example.com',
first_name: 'Ada',
last_name: 'Lovelace',
phone_number: '+15551234567'
}
],
schedule_type: 'immediate',
scheduled_at: '2026-03-20T09:00:00Z',
timezone: 'America/New_York',
start_time: '09:00',
end_time: '17:30',
working_days: [1, 2, 3, 4, 5],
max_concurrent_calls: 10,
max_calls_per_day: 500,
retry_failed: false,
max_retry_attempts: 2
})
};
fetch('https://api.truedy.ai/api/public/v1/batch-calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.truedy.ai/api/public/v1/batch-calls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'March follow-up campaign',
'agent_id' => 'agt_123e4567-e89b-12d3-a456-426614174000',
'phone_number_ids' => [
'num_11111111-1111-1111-1111-111111111111'
],
'phone_rotation_strategy' => 'random',
'contact_source' => 'csv',
'contact_folder_id' => '<string>',
'contact_ids' => [
'ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'
],
'contacts' => [
[
'email' => 'ada@example.com',
'first_name' => 'Ada',
'last_name' => 'Lovelace',
'phone_number' => '+15551234567'
]
],
'schedule_type' => 'immediate',
'scheduled_at' => '2026-03-20T09:00:00Z',
'timezone' => 'America/New_York',
'start_time' => '09:00',
'end_time' => '17:30',
'working_days' => [
1,
2,
3,
4,
5
],
'max_concurrent_calls' => 10,
'max_calls_per_day' => 500,
'retry_failed' => false,
'max_retry_attempts' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truedy.ai/api/public/v1/batch-calls"
payload := strings.NewReader("{\n \"name\": \"March follow-up campaign\",\n \"agent_id\": \"agt_123e4567-e89b-12d3-a456-426614174000\",\n \"phone_number_ids\": [\n \"num_11111111-1111-1111-1111-111111111111\"\n ],\n \"phone_rotation_strategy\": \"random\",\n \"contact_source\": \"csv\",\n \"contact_folder_id\": \"<string>\",\n \"contact_ids\": [\n \"ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n ],\n \"contacts\": [\n {\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone_number\": \"+15551234567\"\n }\n ],\n \"schedule_type\": \"immediate\",\n \"scheduled_at\": \"2026-03-20T09:00:00Z\",\n \"timezone\": \"America/New_York\",\n \"start_time\": \"09:00\",\n \"end_time\": \"17:30\",\n \"working_days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"max_concurrent_calls\": 10,\n \"max_calls_per_day\": 500,\n \"retry_failed\": false,\n \"max_retry_attempts\": 2\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.truedy.ai/api/public/v1/batch-calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"March follow-up campaign\",\n \"agent_id\": \"agt_123e4567-e89b-12d3-a456-426614174000\",\n \"phone_number_ids\": [\n \"num_11111111-1111-1111-1111-111111111111\"\n ],\n \"phone_rotation_strategy\": \"random\",\n \"contact_source\": \"csv\",\n \"contact_folder_id\": \"<string>\",\n \"contact_ids\": [\n \"ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n ],\n \"contacts\": [\n {\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone_number\": \"+15551234567\"\n }\n ],\n \"schedule_type\": \"immediate\",\n \"scheduled_at\": \"2026-03-20T09:00:00Z\",\n \"timezone\": \"America/New_York\",\n \"start_time\": \"09:00\",\n \"end_time\": \"17:30\",\n \"working_days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"max_concurrent_calls\": 10,\n \"max_calls_per_day\": 500,\n \"retry_failed\": false,\n \"max_retry_attempts\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.truedy.ai/api/public/v1/batch-calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"March follow-up campaign\",\n \"agent_id\": \"agt_123e4567-e89b-12d3-a456-426614174000\",\n \"phone_number_ids\": [\n \"num_11111111-1111-1111-1111-111111111111\"\n ],\n \"phone_rotation_strategy\": \"random\",\n \"contact_source\": \"csv\",\n \"contact_folder_id\": \"<string>\",\n \"contact_ids\": [\n \"ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n ],\n \"contacts\": [\n {\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone_number\": \"+15551234567\"\n }\n ],\n \"schedule_type\": \"immediate\",\n \"scheduled_at\": \"2026-03-20T09:00:00Z\",\n \"timezone\": \"America/New_York\",\n \"start_time\": \"09:00\",\n \"end_time\": \"17:30\",\n \"working_days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"max_concurrent_calls\": 10,\n \"max_calls_per_day\": 500,\n \"retry_failed\": false,\n \"max_retry_attempts\": 2\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"agent_id": "<string>",
"phone_rotation_strategy": "<string>",
"contact_source": "<string>",
"status": "<string>",
"schedule_type": "<string>",
"timezone": "<string>",
"max_concurrent_calls": 123,
"retry_failed": true,
"max_retry_attempts": 123,
"total_contacts": 123,
"completed_contacts": 123,
"successful_contacts": 123,
"failed_contacts": 123,
"voicemail_contacts": 123,
"no_answer_contacts": 123,
"total_cost_usd": 123,
"average_duration_seconds": 123,
"created_at": "2023-11-07T05:31:56Z",
"clerk_org_id": "<string>",
"phone_number_ids": [
"<string>"
],
"contact_folder_id": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"start_time": "<string>",
"end_time": "<string>",
"working_days": [
123
],
"max_calls_per_day": 123,
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"ts": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}Batch Calls
Create Batch Call
Create a batch call (campaign). Supports folder, contact_ids, and inline contacts.
POST
/
batch-calls
Create Batch Call
curl --request POST \
--url https://api.truedy.ai/api/public/v1/batch-calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "March follow-up campaign",
"agent_id": "agt_123e4567-e89b-12d3-a456-426614174000",
"phone_number_ids": [
"num_11111111-1111-1111-1111-111111111111"
],
"phone_rotation_strategy": "random",
"contact_source": "csv",
"contact_folder_id": "<string>",
"contact_ids": [
"ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
],
"contacts": [
{
"email": "ada@example.com",
"first_name": "Ada",
"last_name": "Lovelace",
"phone_number": "+15551234567"
}
],
"schedule_type": "immediate",
"scheduled_at": "2026-03-20T09:00:00Z",
"timezone": "America/New_York",
"start_time": "09:00",
"end_time": "17:30",
"working_days": [
1,
2,
3,
4,
5
],
"max_concurrent_calls": 10,
"max_calls_per_day": 500,
"retry_failed": false,
"max_retry_attempts": 2
}
'import requests
url = "https://api.truedy.ai/api/public/v1/batch-calls"
payload = {
"name": "March follow-up campaign",
"agent_id": "agt_123e4567-e89b-12d3-a456-426614174000",
"phone_number_ids": ["num_11111111-1111-1111-1111-111111111111"],
"phone_rotation_strategy": "random",
"contact_source": "csv",
"contact_folder_id": "<string>",
"contact_ids": ["ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"],
"contacts": [
{
"email": "ada@example.com",
"first_name": "Ada",
"last_name": "Lovelace",
"phone_number": "+15551234567"
}
],
"schedule_type": "immediate",
"scheduled_at": "2026-03-20T09:00:00Z",
"timezone": "America/New_York",
"start_time": "09:00",
"end_time": "17:30",
"working_days": [1, 2, 3, 4, 5],
"max_concurrent_calls": 10,
"max_calls_per_day": 500,
"retry_failed": False,
"max_retry_attempts": 2
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'March follow-up campaign',
agent_id: 'agt_123e4567-e89b-12d3-a456-426614174000',
phone_number_ids: ['num_11111111-1111-1111-1111-111111111111'],
phone_rotation_strategy: 'random',
contact_source: 'csv',
contact_folder_id: '<string>',
contact_ids: ['ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'],
contacts: [
{
email: 'ada@example.com',
first_name: 'Ada',
last_name: 'Lovelace',
phone_number: '+15551234567'
}
],
schedule_type: 'immediate',
scheduled_at: '2026-03-20T09:00:00Z',
timezone: 'America/New_York',
start_time: '09:00',
end_time: '17:30',
working_days: [1, 2, 3, 4, 5],
max_concurrent_calls: 10,
max_calls_per_day: 500,
retry_failed: false,
max_retry_attempts: 2
})
};
fetch('https://api.truedy.ai/api/public/v1/batch-calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.truedy.ai/api/public/v1/batch-calls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'March follow-up campaign',
'agent_id' => 'agt_123e4567-e89b-12d3-a456-426614174000',
'phone_number_ids' => [
'num_11111111-1111-1111-1111-111111111111'
],
'phone_rotation_strategy' => 'random',
'contact_source' => 'csv',
'contact_folder_id' => '<string>',
'contact_ids' => [
'ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'
],
'contacts' => [
[
'email' => 'ada@example.com',
'first_name' => 'Ada',
'last_name' => 'Lovelace',
'phone_number' => '+15551234567'
]
],
'schedule_type' => 'immediate',
'scheduled_at' => '2026-03-20T09:00:00Z',
'timezone' => 'America/New_York',
'start_time' => '09:00',
'end_time' => '17:30',
'working_days' => [
1,
2,
3,
4,
5
],
'max_concurrent_calls' => 10,
'max_calls_per_day' => 500,
'retry_failed' => false,
'max_retry_attempts' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truedy.ai/api/public/v1/batch-calls"
payload := strings.NewReader("{\n \"name\": \"March follow-up campaign\",\n \"agent_id\": \"agt_123e4567-e89b-12d3-a456-426614174000\",\n \"phone_number_ids\": [\n \"num_11111111-1111-1111-1111-111111111111\"\n ],\n \"phone_rotation_strategy\": \"random\",\n \"contact_source\": \"csv\",\n \"contact_folder_id\": \"<string>\",\n \"contact_ids\": [\n \"ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n ],\n \"contacts\": [\n {\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone_number\": \"+15551234567\"\n }\n ],\n \"schedule_type\": \"immediate\",\n \"scheduled_at\": \"2026-03-20T09:00:00Z\",\n \"timezone\": \"America/New_York\",\n \"start_time\": \"09:00\",\n \"end_time\": \"17:30\",\n \"working_days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"max_concurrent_calls\": 10,\n \"max_calls_per_day\": 500,\n \"retry_failed\": false,\n \"max_retry_attempts\": 2\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.truedy.ai/api/public/v1/batch-calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"March follow-up campaign\",\n \"agent_id\": \"agt_123e4567-e89b-12d3-a456-426614174000\",\n \"phone_number_ids\": [\n \"num_11111111-1111-1111-1111-111111111111\"\n ],\n \"phone_rotation_strategy\": \"random\",\n \"contact_source\": \"csv\",\n \"contact_folder_id\": \"<string>\",\n \"contact_ids\": [\n \"ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n ],\n \"contacts\": [\n {\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone_number\": \"+15551234567\"\n }\n ],\n \"schedule_type\": \"immediate\",\n \"scheduled_at\": \"2026-03-20T09:00:00Z\",\n \"timezone\": \"America/New_York\",\n \"start_time\": \"09:00\",\n \"end_time\": \"17:30\",\n \"working_days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"max_concurrent_calls\": 10,\n \"max_calls_per_day\": 500,\n \"retry_failed\": false,\n \"max_retry_attempts\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.truedy.ai/api/public/v1/batch-calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"March follow-up campaign\",\n \"agent_id\": \"agt_123e4567-e89b-12d3-a456-426614174000\",\n \"phone_number_ids\": [\n \"num_11111111-1111-1111-1111-111111111111\"\n ],\n \"phone_rotation_strategy\": \"random\",\n \"contact_source\": \"csv\",\n \"contact_folder_id\": \"<string>\",\n \"contact_ids\": [\n \"ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n ],\n \"contacts\": [\n {\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"phone_number\": \"+15551234567\"\n }\n ],\n \"schedule_type\": \"immediate\",\n \"scheduled_at\": \"2026-03-20T09:00:00Z\",\n \"timezone\": \"America/New_York\",\n \"start_time\": \"09:00\",\n \"end_time\": \"17:30\",\n \"working_days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"max_concurrent_calls\": 10,\n \"max_calls_per_day\": 500,\n \"retry_failed\": false,\n \"max_retry_attempts\": 2\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"agent_id": "<string>",
"phone_rotation_strategy": "<string>",
"contact_source": "<string>",
"status": "<string>",
"schedule_type": "<string>",
"timezone": "<string>",
"max_concurrent_calls": 123,
"retry_failed": true,
"max_retry_attempts": 123,
"total_contacts": 123,
"completed_contacts": 123,
"successful_contacts": 123,
"failed_contacts": 123,
"voicemail_contacts": 123,
"no_answer_contacts": 123,
"total_cost_usd": 123,
"average_duration_seconds": 123,
"created_at": "2023-11-07T05:31:56Z",
"clerk_org_id": "<string>",
"phone_number_ids": [
"<string>"
],
"contact_folder_id": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"start_time": "<string>",
"end_time": "<string>",
"working_days": [
123
],
"max_calls_per_day": 123,
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"ts": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}Authorizations
Your API key. Send in the Authorization header as: Bearer
Headers
Body
application/json
Create batch call request with enhanced features
Human-friendly campaign name
Required string length:
1 - 255Example:
"March follow-up campaign"
Internal agent UUID
Example:
"agt_123e4567-e89b-12d3-a456-426614174000"
Array of phone number UUIDs (optional, auto-fills from agent if empty)
Example:
["num_11111111-1111-1111-1111-111111111111"]
Available options:
random, sequential, round_robin Available options:
csv, folder, manual Existing contact IDs from your contacts table to add to this batch call
Example:
["ctc_aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"]
Inline contacts: list of objects with phone_number (required), and optional first_name, last_name, email, custom_fields
Example:
[
{
"email": "ada@example.com",
"first_name": "Ada",
"last_name": "Lovelace",
"phone_number": "+15551234567"
}
]
Available options:
immediate, scheduled When to start the campaign (UTC). Required if schedule_type is 'scheduled'.
Example:
"2026-03-20T09:00:00Z"
IANA timezone used to interpret daily start/end windows
Example:
"America/New_York"
Daily start time (HH:MM format)
Example:
"09:00"
Daily end time (HH:MM format)
Example:
"17:30"
Working days as integers (1=Mon, 7=Sun)
Example:
[1, 2, 3, 4, 5]
Internal concurrency limit (auto-managed)
Required range:
1 <= x <= 100Number of calls to make per day — primary scheduling control
Required range:
x >= 1Auto-retry attempts for system errors
Required range:
0 <= x <= 3⌘I