POST
/
v1
/
campaigns

Authorizations

X-Api-Key
string
header
required

Your API key.

Body

application/json
agentId
string
required

Unique identifier of the OUTBOUND agent to perform the campaign with

batchSize
integer
required

The number of calls per day, minimum 1, maximum 1000

Required range: 1 < x < 1000
days
enum<string>[]
required

Days of the campaign

Available options:
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY,
SUNDAY
name
string
required

Name of the campaign

startDate
string
required

Start date of the campaign

timeSlots
object[]
required

Timeslots of the campaign (when the calls will be performed during the day). Maximum 2 timeslots

recipients
object[]

List of recipients to call, minimum 1, maximum 1000

retry
object

Retry parameters when the contact cannot be reached

Response

201 - application/json
agentId
string

Unique identifier of the agent to perform the campaign with

batchSize
integer

The number of calls per...

days
enum<string>[]

Days of the campaign

Available options:
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY,
SUNDAY
id
string

Unique identifier of the campaign

name
string

Name of the campaign

retry
object

Retry parameters when the contact cannot be reached

startDate
string

Start date of the campaign

status
enum<string>

Status of the campaign

Available options:
ACTIVE,
PAUSED,
CANCELLED
timeSlots
object[]

Timeslots of the campaign (when the calls will be performed during the day). Max 2 timeslots