Create Campaign
Create a managed batch calling campaign with lifecycle controls.
Batch calls vs. campaigns
Workflow
- Create the campaign with this endpoint.
- Add leads via Bulk Upload or Add Lead.
- Monitor delivery using campaign lead endpoints and call logs.
- Update campaign details when needed.
- Track each lead’s progress through campaign lead endpoints and call logs.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
RSA encrypted organization ID (base64 format)
"BASE64_ENCRYPTED_ORG_ID_HERE"
Body
Title of the campaign (max 150 characters)
150"New Product Launch"
Agent ID associated with the campaign
101
Agent Version ID associated with the campaign
1
Start timestamp of the campaign (ISO string)
"2025-05-10T09:00:00Z"
End timestamp of the campaign (ISO string)
"2025-05-20T18:00:00Z"
Start of allowed calling hours (HH:mm format only, not full datetime)
"09:00"
End of allowed calling hours (HH:mm format only, not full datetime)
"18:00"
Total Number of Leads for this Campaign
"10"
Status of the campaign
draft, waiting, running, paused, completed, cancelled, deleted, scheduled "draft"
Number of retries for the campaign (0-5)
3
Interval between retries in minutes (0-1440)
15
Response
Campaign created successfully