Skip to main content
POST
/
v1
/
campaigns
Create a campaign
curl --request POST \
  --url https://api.eu.volubile.ai/v1/campaigns \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2024-07-30",
  "timeSlots": [
    {
      "startTime": "10:30",
      "endTime": "12:30"
    }
  ],
  "batchSize": 500,
  "retry": {
    "max": 1,
    "delay": 123,
    "retryOn": [
      "<string>"
    ]
  },
  "days": [
    "MONDAY"
  ],
  "recipients": [
    {
      "phone": "+33612345678",
      "context": {
        "firstName": "firstname",
        "lastName": "lastname",
        "orderNumber": "5HZ99FRT"
      }
    }
  ],
  "timezone": "Europe/Paris"
}'
{
  "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.

Body

application/json
​
name
string
required

Name of the campaign

​
agentId
string<uuid>
required

Unique identifier of the OUTBOUND agent to perform the campaign with

​
startDate
string<date>
required

Start date of the campaign

Example:

"2024-07-30"

​
timeSlots
object[]
required

Calls will only be performed during the allowed time slots: 10:00-13:00 and 14:00-20:00. If the specified time slots overlap partially with these intervals, only the overlapping portion will be used. For example: if "11:00-15:00" is provided, calls will occur from 11:00 to 13:00 and 14:00 to 15:00. Maximum of 2 time slots are allowed

​
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

​
retry
object

Retry parameters when the contact cannot be reached

​
recipients
object[]

List of recipients to call, minimum 1, maximum 1000

​
timezone
string

The timezone of the campaign

Example:

"Europe/Paris"

Response

Created

​
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

​
batchSize
integer

The number of calls per...

​
retry
object

Retry parameters when the contact cannot be reached

​
days
enum<string>[]

Days of the campaign

​
status
enum<string>

Status of the campaign

Available options:
ACTIVE,
PAUSED,
CANCELLED
​
timezone
string

The timezone of the campaign

Example:

"Europe/Paris"