Skip to navigation
Campaigns

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.
namestringRequired1-100 characters
Campaign name
agent_idstringRequired>=1 character
Voice agent UUID
phone_numberstringRequired>=1 character
Source phone number
phone_columnstring or nullOptional>=1 character

Field containing phone numbers: ‘phone’ for contacts if left out; for contacts_upload_id, the column Levrage found to hold phone numbers

contactslist of objects or nullOptional

Contacts array (max 2000). For a bigger list use contacts_upload_id.

contacts_upload_idstring or nullOptional

A sheet you uploaded (GET /v1/uploads) instead of contacts: every row with a phone number, up to 10,000 from first_row. Rows without a number are left out and counted.

first_rowintegerOptional>=1Defaults to 1

With contacts_upload_id: the first row to call (1 = the first under the header)

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
from_fileobject or nullOptional

With contacts_upload_id: the file, the rows called (first_row–last_row), rows left out for having no phone number, and rows with a number left for another campaign (over 10,000)

Errors

422
Unprocessable Entity Error