Update campaign status - Documentation

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2024-07-30",
  "timeSlots": [
    {
      "startTime": "10:30",
      "endTime": "12:30"
    }
  ],
  "batchSize": 123,
  "retry": {
    "max": 1,
    "delay": 123,
    "retryOn": [
      "<string>"
    ]
  },
  "days": [
    "MONDAY"
  ],
  "status": "ACTIVE",
  "timezone": "Europe/Paris"
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "rejectedValue": {},
      "message": "<string>"
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "rejectedValue": {},
      "message": "<string>"
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "rejectedValue": {},
      "message": "<string>"
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "rejectedValue": {},
      "message": "<string>"
    }
  ]
}

POST

/

v1

/

campaigns

/

{id}

/

status

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2024-07-30",
  "timeSlots": [
    {
      "startTime": "10:30",
      "endTime": "12:30"
    }
  ],
  "batchSize": 123,
  "retry": {
    "max": 1,
    "delay": 123,
    "retryOn": [
      "<string>"
    ]
  },
  "days": [
    "MONDAY"
  ],
  "status": "ACTIVE",
  "timezone": "Europe/Paris"
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "rejectedValue": {},
      "message": "<string>"
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "rejectedValue": {},
      "message": "<string>"
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "rejectedValue": {},
      "message": "<string>"
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "rejectedValue": {},
      "message": "<string>"
    }
  ]
}

Authorizations

X-Api-Key

string

header

required

Your API key.

Path Parameters

id

string<uuid>

required

Body

application/json

The body is of type enum<string>.

Available options:

ACTIVE,

PAUSED,

CANCELLED

Response

OK

id

string<uuid>

Unique identifier of the campaign

name

string

Name of the campaign

agentId

string<uuid>

Unique identifier of the agent to perform the campaign with

startDate

string<date>

Start date of the campaign

Example:

"2024-07-30"

timeSlots

object[]

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

Show child attributes

batchSize

integer<int32>

The number of calls per...

retry

object

Retry parameters when the contact cannot be reached

Show child attributes

days

enum<string>[]

Days of the campaign

Days of the campaign

Available options:

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY,

SUNDAY

status

enum<string>

Status of the campaign

Available options:

ACTIVE,

PAUSED,

CANCELLED

timezone

string

The timezone of the campaign

Example:

"Europe/Paris"