Create Campaign
curl --request POST \
--url https://api.example.com/api/v1/campaigns \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"workflow_id": 123,
"source_type": "<string>",
"goal": "<string>",
"source_id": "",
"manual_contacts": [
{
"phone_number": "<string>",
"first_name": "",
"last_name": ""
}
],
"source_config": {},
"retry_config": {
"enabled": true,
"max_retries": 1,
"retry_delay_seconds": 3600,
"retry_on_busy": true,
"retry_on_no_answer": true,
"retry_on_voicemail": false,
"smart_timing": false
},
"source_refresh_minutes": 5042,
"scheduled_start_at": "2023-11-07T05:31:56Z",
"calling_window": {
"timezone": "Europe/Warsaw",
"days": [
1,
2,
3,
4,
5
],
"start": "09:00",
"end": "17:00"
}
}
'import requests
url = "https://api.example.com/api/v1/campaigns"
payload = {
"name": "<string>",
"workflow_id": 123,
"source_type": "<string>",
"goal": "<string>",
"source_id": "",
"manual_contacts": [
{
"phone_number": "<string>",
"first_name": "",
"last_name": ""
}
],
"source_config": {},
"retry_config": {
"enabled": True,
"max_retries": 1,
"retry_delay_seconds": 3600,
"retry_on_busy": True,
"retry_on_no_answer": True,
"retry_on_voicemail": False,
"smart_timing": False
},
"source_refresh_minutes": 5042,
"scheduled_start_at": "2023-11-07T05:31:56Z",
"calling_window": {
"timezone": "Europe/Warsaw",
"days": [1, 2, 3, 4, 5],
"start": "09:00",
"end": "17:00"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
workflow_id: 123,
source_type: '<string>',
goal: '<string>',
source_id: '',
manual_contacts: [{phone_number: '<string>', first_name: '', last_name: ''}],
source_config: {},
retry_config: {
enabled: true,
max_retries: 1,
retry_delay_seconds: 3600,
retry_on_busy: true,
retry_on_no_answer: true,
retry_on_voicemail: false,
smart_timing: false
},
source_refresh_minutes: 5042,
scheduled_start_at: '2023-11-07T05:31:56Z',
calling_window: {timezone: 'Europe/Warsaw', days: [1, 2, 3, 4, 5], start: '09:00', end: '17:00'}
})
};
fetch('https://api.example.com/api/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'workflow_id' => 123,
'source_type' => '<string>',
'goal' => '<string>',
'source_id' => '',
'manual_contacts' => [
[
'phone_number' => '<string>',
'first_name' => '',
'last_name' => ''
]
],
'source_config' => [
],
'retry_config' => [
'enabled' => true,
'max_retries' => 1,
'retry_delay_seconds' => 3600,
'retry_on_busy' => true,
'retry_on_no_answer' => true,
'retry_on_voicemail' => false,
'smart_timing' => false
],
'source_refresh_minutes' => 5042,
'scheduled_start_at' => '2023-11-07T05:31:56Z',
'calling_window' => [
'timezone' => 'Europe/Warsaw',
'days' => [
1,
2,
3,
4,
5
],
'start' => '09:00',
'end' => '17:00'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"workflow_id\": 123,\n \"source_type\": \"<string>\",\n \"goal\": \"<string>\",\n \"source_id\": \"\",\n \"manual_contacts\": [\n {\n \"phone_number\": \"<string>\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"source_config\": {},\n \"retry_config\": {\n \"enabled\": true,\n \"max_retries\": 1,\n \"retry_delay_seconds\": 3600,\n \"retry_on_busy\": true,\n \"retry_on_no_answer\": true,\n \"retry_on_voicemail\": false,\n \"smart_timing\": false\n },\n \"source_refresh_minutes\": 5042,\n \"scheduled_start_at\": \"2023-11-07T05:31:56Z\",\n \"calling_window\": {\n \"timezone\": \"Europe/Warsaw\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/campaigns")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"workflow_id\": 123,\n \"source_type\": \"<string>\",\n \"goal\": \"<string>\",\n \"source_id\": \"\",\n \"manual_contacts\": [\n {\n \"phone_number\": \"<string>\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"source_config\": {},\n \"retry_config\": {\n \"enabled\": true,\n \"max_retries\": 1,\n \"retry_delay_seconds\": 3600,\n \"retry_on_busy\": true,\n \"retry_on_no_answer\": true,\n \"retry_on_voicemail\": false,\n \"smart_timing\": false\n },\n \"source_refresh_minutes\": 5042,\n \"scheduled_start_at\": \"2023-11-07T05:31:56Z\",\n \"calling_window\": {\n \"timezone\": \"Europe/Warsaw\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"workflow_id\": 123,\n \"source_type\": \"<string>\",\n \"goal\": \"<string>\",\n \"source_id\": \"\",\n \"manual_contacts\": [\n {\n \"phone_number\": \"<string>\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"source_config\": {},\n \"retry_config\": {\n \"enabled\": true,\n \"max_retries\": 1,\n \"retry_delay_seconds\": 3600,\n \"retry_on_busy\": true,\n \"retry_on_no_answer\": true,\n \"retry_on_voicemail\": false,\n \"smart_timing\": false\n },\n \"source_refresh_minutes\": 5042,\n \"scheduled_start_at\": \"2023-11-07T05:31:56Z\",\n \"calling_window\": {\n \"timezone\": \"Europe/Warsaw\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"workflow_id": 123,
"workflow_name": "<string>",
"state": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"total_rows": 123,
"processed_rows": 123,
"failed_rows": 123,
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"goal": "<string>",
"source_config": {},
"source_refresh_minutes": 123,
"source_last_synced_at": "2023-11-07T05:31:56Z",
"source_sync_error": "<string>",
"scheduled_start_at": "2023-11-07T05:31:56Z",
"calling_window": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Campaigns
Create Campaign
Create a new campaign
POST
/
api
/
v1
/
campaigns
Create Campaign
curl --request POST \
--url https://api.example.com/api/v1/campaigns \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"workflow_id": 123,
"source_type": "<string>",
"goal": "<string>",
"source_id": "",
"manual_contacts": [
{
"phone_number": "<string>",
"first_name": "",
"last_name": ""
}
],
"source_config": {},
"retry_config": {
"enabled": true,
"max_retries": 1,
"retry_delay_seconds": 3600,
"retry_on_busy": true,
"retry_on_no_answer": true,
"retry_on_voicemail": false,
"smart_timing": false
},
"source_refresh_minutes": 5042,
"scheduled_start_at": "2023-11-07T05:31:56Z",
"calling_window": {
"timezone": "Europe/Warsaw",
"days": [
1,
2,
3,
4,
5
],
"start": "09:00",
"end": "17:00"
}
}
'import requests
url = "https://api.example.com/api/v1/campaigns"
payload = {
"name": "<string>",
"workflow_id": 123,
"source_type": "<string>",
"goal": "<string>",
"source_id": "",
"manual_contacts": [
{
"phone_number": "<string>",
"first_name": "",
"last_name": ""
}
],
"source_config": {},
"retry_config": {
"enabled": True,
"max_retries": 1,
"retry_delay_seconds": 3600,
"retry_on_busy": True,
"retry_on_no_answer": True,
"retry_on_voicemail": False,
"smart_timing": False
},
"source_refresh_minutes": 5042,
"scheduled_start_at": "2023-11-07T05:31:56Z",
"calling_window": {
"timezone": "Europe/Warsaw",
"days": [1, 2, 3, 4, 5],
"start": "09:00",
"end": "17:00"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
workflow_id: 123,
source_type: '<string>',
goal: '<string>',
source_id: '',
manual_contacts: [{phone_number: '<string>', first_name: '', last_name: ''}],
source_config: {},
retry_config: {
enabled: true,
max_retries: 1,
retry_delay_seconds: 3600,
retry_on_busy: true,
retry_on_no_answer: true,
retry_on_voicemail: false,
smart_timing: false
},
source_refresh_minutes: 5042,
scheduled_start_at: '2023-11-07T05:31:56Z',
calling_window: {timezone: 'Europe/Warsaw', days: [1, 2, 3, 4, 5], start: '09:00', end: '17:00'}
})
};
fetch('https://api.example.com/api/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'workflow_id' => 123,
'source_type' => '<string>',
'goal' => '<string>',
'source_id' => '',
'manual_contacts' => [
[
'phone_number' => '<string>',
'first_name' => '',
'last_name' => ''
]
],
'source_config' => [
],
'retry_config' => [
'enabled' => true,
'max_retries' => 1,
'retry_delay_seconds' => 3600,
'retry_on_busy' => true,
'retry_on_no_answer' => true,
'retry_on_voicemail' => false,
'smart_timing' => false
],
'source_refresh_minutes' => 5042,
'scheduled_start_at' => '2023-11-07T05:31:56Z',
'calling_window' => [
'timezone' => 'Europe/Warsaw',
'days' => [
1,
2,
3,
4,
5
],
'start' => '09:00',
'end' => '17:00'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"workflow_id\": 123,\n \"source_type\": \"<string>\",\n \"goal\": \"<string>\",\n \"source_id\": \"\",\n \"manual_contacts\": [\n {\n \"phone_number\": \"<string>\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"source_config\": {},\n \"retry_config\": {\n \"enabled\": true,\n \"max_retries\": 1,\n \"retry_delay_seconds\": 3600,\n \"retry_on_busy\": true,\n \"retry_on_no_answer\": true,\n \"retry_on_voicemail\": false,\n \"smart_timing\": false\n },\n \"source_refresh_minutes\": 5042,\n \"scheduled_start_at\": \"2023-11-07T05:31:56Z\",\n \"calling_window\": {\n \"timezone\": \"Europe/Warsaw\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/campaigns")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"workflow_id\": 123,\n \"source_type\": \"<string>\",\n \"goal\": \"<string>\",\n \"source_id\": \"\",\n \"manual_contacts\": [\n {\n \"phone_number\": \"<string>\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"source_config\": {},\n \"retry_config\": {\n \"enabled\": true,\n \"max_retries\": 1,\n \"retry_delay_seconds\": 3600,\n \"retry_on_busy\": true,\n \"retry_on_no_answer\": true,\n \"retry_on_voicemail\": false,\n \"smart_timing\": false\n },\n \"source_refresh_minutes\": 5042,\n \"scheduled_start_at\": \"2023-11-07T05:31:56Z\",\n \"calling_window\": {\n \"timezone\": \"Europe/Warsaw\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"workflow_id\": 123,\n \"source_type\": \"<string>\",\n \"goal\": \"<string>\",\n \"source_id\": \"\",\n \"manual_contacts\": [\n {\n \"phone_number\": \"<string>\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"source_config\": {},\n \"retry_config\": {\n \"enabled\": true,\n \"max_retries\": 1,\n \"retry_delay_seconds\": 3600,\n \"retry_on_busy\": true,\n \"retry_on_no_answer\": true,\n \"retry_on_voicemail\": false,\n \"smart_timing\": false\n },\n \"source_refresh_minutes\": 5042,\n \"scheduled_start_at\": \"2023-11-07T05:31:56Z\",\n \"calling_window\": {\n \"timezone\": \"Europe/Warsaw\",\n \"days\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"workflow_id": 123,
"workflow_name": "<string>",
"state": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"total_rows": 123,
"processed_rows": 123,
"failed_rows": 123,
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"goal": "<string>",
"source_config": {},
"source_refresh_minutes": 123,
"source_last_synced_at": "2023-11-07T05:31:56Z",
"source_sync_error": "<string>",
"scheduled_start_at": "2023-11-07T05:31:56Z",
"calling_window": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).
Body
application/json
Required string length:
1 - 255Pattern:
^(google-sheet|csv|manual|calendar)$Maximum string length:
64Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
5 <= x <= 10080Hours a campaign may dial in, in the customer's own timezone.
Show child attributes
Show child attributes
Response
Successful Response