Create Campaign

Create a new campaign to call multiple contacts. Supports scheduling, retry configuration, and blackout periods.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired<=100 characters
Campaign name
agent_idstringRequired
Voice agent UUID
phone_numberstringRequired
Source phone number
contactslist of objectsRequired

Contacts array (max 2000)

phone_columnstringOptionalDefaults to phone
Field containing phone numbers
max_concurrent_callsintegerOptional1-50Defaults to 1

Parallel calls (1-50)

schedule_timedatetime or nullOptional

Schedule for future (ISO 8601)

timezonestring or nullOptional

Timezone e.g. ‘Asia/Kolkata’

start_timedatetime or nullOptional
Campaign start time
end_timedatetime or nullOptional
Campaign end time
daily_start_timestring or nullOptional

Daily calling start HH:MM

daily_end_timestring or nullOptional

Daily calling end HH:MM

retry_configobject or nullOptional
Retry settings for failed calls
blackout_periodslist of objects or nullOptional

No-call time windows

Response

Successful Response
dataobject
Campaign data inside response envelope.
request_idstring
timestampdatetime
successbooleanOptionalDefaults to true

Errors

422
Unprocessable Entity Error