v2

latestOpenAPI 3.1.02026-07-273779120.8 KB

Campaigns Calls

Campaign Calls

Upload Calls

Upload a batch of call records to a campaign.

Request body: A JSON array of call objects. Each object must include a phone_number field. Along with optional override_assistant_id, override_schedule and override_timezone fields and you can include any additional fields relevant to the call (e.g. patientId, insuranceId, etc.). These extra fields are dynamic variables from attached assistant or workflow and will be stored as part of the call record's payload for use in the campaign.

Calls can be uploaded while the campaign is already running — they will be picked up automatically. Returns 202 Accepted immediately; actual call processing happens asynchronously.

post/campaigns/v1/campaigns/{campaign_id}/calls

Path parameters

campaign_idstring required

Example:5eb7cf5a86d9755df3a6c593

Campaign configuration ID

Request body

phone_numberstring required

Target phone number (E.164 format recommended, e.g. '+12065551234')

override_assistant_idstring nullable

Override the campaign's default AI assistant for this specific call

override_timezonestring nullable

IANA timezone override for this call's scheduling window (e.g. 'America/Chicago')

Response

Successful Response

{"stackTrail":"paths:/campaigns/v1/campaigns/{campaign_id}/calls:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}