POST
/
v1
/
campaigns
/
{id}
/
status

Authorizations

X-Api-Key
string
header
required

Your API key.

Path Parameters

id
string
required

Body

application/json · enum<string>

The body is of type enum<string>.

Available options:
ACTIVE,
PAUSED,
CANCELLED

Response

200 - 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