Campaigns

Create Campaign

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Request

This endpoint expects an object.
namestringRequired
This is the name of the campaign. This is just for your own reference.
phoneNumberIdstringRequired
This is the phone number ID that will be used for the campaign calls.
customerslist of objectsRequired
These are the customers that will be called in the campaign.
assistantIdstringOptional

This is the assistant ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both.

workflowIdstringOptional

This is the workflow ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both.

schedulePlanobjectOptional

This is the schedule plan for the campaign. Calls will start at startedAt and continue until your organization’s concurrency limit is reached. Any remaining calls will be retried for up to one hour as capacity becomes available. After that hour or after latestAt, whichever comes first, any calls that couldn’t be placed won’t be retried.

Response

statusenum
This is the status of the campaign.
Allowed values:
namestring
This is the name of the campaign. This is just for your own reference.
phoneNumberIdstring
This is the phone number ID that will be used for the campaign calls.
customerslist of objects
These are the customers that will be called in the campaign.
idstring
This is the unique identifier for the campaign.
orgIdstring
This is the unique identifier for the org that this campaign belongs to.
createdAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the campaign was created.

updatedAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the campaign was last updated.

callsobject
This is a map of call IDs to campaign call details.
callsCounterScheduleddouble
This is the number of calls that have been scheduled.
callsCounterQueueddouble
This is the number of calls that have been queued.
callsCounterInProgressdouble
This is the number of calls that have been in progress.
callsCounterEndedVoicemaildouble
This is the number of calls whose ended reason is 'voicemail'.
callsCounterEndeddouble
This is the number of calls that have ended.
endedReasonenum or null
This is the explanation for how the campaign ended.
Allowed values:
assistantIdstring or null

This is the assistant ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both.

workflowIdstring or null

This is the workflow ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both.

schedulePlanobject or null

This is the schedule plan for the campaign. Calls will start at startedAt and continue until your organization’s concurrency limit is reached. Any remaining calls will be retried for up to one hour as capacity becomes available. After that hour or after latestAt, whichever comes first, any calls that couldn’t be placed won’t be retried.