Campaigns
Create a campaign
Campaigns
Create a campaign
POST
/
v1
/
campaigns
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
Your API key.
Body
application/json
Response
201
application/json
Created
The response is of type object
.
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"
}