Campaigns
Create a campaign
POST
/
v1
/
campaigns
Authorizations
X-Api-Key
string
headerrequiredYour API key.
Body
application/json
name
string
requiredName of the campaign
agentId
string
requiredUnique identifier of the OUTBOUND agent to perform the campaign with
startDate
string
requiredStart date of the campaign
timeSlots
object[]
requiredTimeslots of the campaign (when the calls will be performed during the day). Maximum 2 timeslots
batchSize
integer
requiredThe number of calls per day, minimum 1, maximum 1000
retry
object
Retry parameters when the contact cannot be reached
days
enum<string>[]
requiredDays of the campaign
Available options:
MONDAY
, TUESDAY
, WEDNESDAY
, THURSDAY
, FRIDAY
, SATURDAY
, SUNDAY
recipients
object[]
List of recipients to call, minimum 1, maximum 1000
Response
201 - application/json
id
string
Unique identifier of the campaign
name
string
Name of the campaign
agentId
string
Unique identifier of the agent to perform the campaign with
startDate
string
Start date of the campaign
timeSlots
object[]
Timeslots of the campaign (when the calls will be performed during the day). Max 2 timeslots
batchSize
integer
The number of calls per...
retry
object
Retry parameters when the contact cannot be reached
days
enum<string>[]
Days of the campaign
Available options:
MONDAY
, TUESDAY
, WEDNESDAY
, THURSDAY
, FRIDAY
, SATURDAY
, SUNDAY