Skip to main content
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": "Q4 Sales Batch Call",
  "agent_id": "agt_f9447372-5",
  "contacts": [
    "contact_39b593b8-8"
  ]
}
'
{
  "data": {
    "id": "camp_ccaaff66-6",
    "name": "Q4 Sales Batch Call",
    "status": "scheduled",
    "agent_id": "agt_f9447372-5",
    "created_at": "2026-03-03T20:30:21.310278Z"
  },
  "meta": {
    "request_id": "req_32e7531c-8",
    "timestamp": "2026-03-03T20:30:21.310278Z"
  }
}

Authorizations

Authorization
string
header
required

Your API key. Get it from the Truedy Dashboard. Send as: Authorization: Bearer <your_key>

Body

application/json
name
string
required

Batch call name

Required string length: 1 - 255
agent_id
string
required

Internal agent UUID

phone_number_ids
string[]

Array of phone number UUIDs. Auto-fills from agent if empty.

phone_rotation_strategy
enum<string>
default:random

Strategy for rotating outbound phone numbers

Available options:
random,
sequential,
round_robin
contact_source
enum<string>
default:csv

Source of contacts for the batch call

Available options:
csv,
folder,
manual
contact_folder_id
string | null

Required when contact_source is 'folder'. Contacts from this folder are copied into the batch.

contact_ids
string[] | null

Existing contact IDs from your contacts table to add to this batch call

contacts
Contacts · object[] | null

Inline contacts: list of objects with phone_number (required), and optional first_name, last_name, email, custom_fields

schedule_type
enum<string>
Available options:
immediate,
scheduled
scheduled_at
string<date-time> | null

Required when schedule_type is 'scheduled'

timezone
string
default:UTC

IANA timezone string

start_time
string | null

Daily start time in HH:MM format

end_time
string | null

Daily end time in HH:MM format

working_days
integer[]

1=Mon, 2=Tue, ..., 7=Sun

max_calls_per_day
integer | null
default:500

Number of calls to make per day. Capped by your billing tier.

Required range: x >= 1
retry_failed
boolean
default:true

Auto-retry failed calls

Response

Resource created successfully

Response body