Update campaign status

curl --request POST \
  --url https://api.eu.volubile.ai/v1/campaigns/{id}/status \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '"ACTIVE"'

{
  "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"
}

POST

campaigns

{id}

status

Update campaign status

curl --request POST \
  --url https://api.eu.volubile.ai/v1/campaigns/{id}/status \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '"ACTIVE"'

{
  "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"
}

Authorizations

X-Api-Key

string

header

required

Your API key.

Path Parameters

string<uuid>

required

Body

application/json

The body is of type enum<string>.

Available options:

ACTIVE,

PAUSED,

CANCELLED

Response

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

timeSlots.startTime

string

required

Start of the time slot.

Format: UTC time - 'HH:mm'

Example:

"10:30"

timeSlots.endTime

string

required

End of the time slot.

Format: UTC time - 'HH:mm'

Example:

"12:30"

batchSize

integer<int32>

The number of calls per...

retry

object

Retry parameters when the contact cannot be reached

Show child attributes

retry.max

integer<int32>

Maximum number of retries to reach the contact, minimum 0 (no retries), maximum 3

Required range: 0 <= x <= 3

retry.delay

integer<int32>

Minimum delay between retry attempts (in hours), minimum 1 (only considered when 'max' is greater than zero)

retry.retryOn

string[]

Condition to trigger a retry (call status and qualifiers), must not be empty (only considered when 'max' is greater than zero)

days

enum<string>[]

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"

⌘I