Campaigns
Create a Campaign
Send large volumes of calls at once with follow-up sequences.
POST
/
v1
/
campaigns
Headers
authorization
string
requiredYour API key for authentication.
Body
name
string
requiredName for your campaign to later reference.
numbers
string[]
requiredAn array of strings containing different phone numbers.
Example:
["+19543110000", "..."]
sequence
object
requiredA list of strings with different phone numbers.
sequence.retries
- (INTEGER) Number of times to retry when no answer.
sequence.wait_period
- (INTEGER) Number of days to wait in between follow ups (retries).
Example:
{
...,
"sequence":{
"retries": 4,
"wait_period": 1
}
}
*
All other parameters supported by the Send Call endpoint are supported here as well. They will be applied to each call in the batch.
Response
status
string
Confirms the request was successful, or provides an error message if the request failed.
campaign_id
string
The unique identifier for the campaign.