Create Campaign
curl --request POST \
--url 'https://api.example.com/api/v1/campaign/create?api_key=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "outbound_call",
"start_time": "2023-11-07T05:31:56Z",
"interval": 123,
"widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {},
"status": "not_started",
"execution_weekdays": [],
"time_window_start": "<string>",
"time_window_end": "<string>",
"time_zone": "UTC",
"enabled": false
}
'import requests
url = "https://api.example.com/api/v1/campaign/create?api_key="
payload = {
"name": "<string>",
"type": "outbound_call",
"start_time": "2023-11-07T05:31:56Z",
"interval": 123,
"widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {},
"status": "not_started",
"execution_weekdays": [],
"time_window_start": "<string>",
"time_window_end": "<string>",
"time_zone": "UTC",
"enabled": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: 'outbound_call',
start_time: '2023-11-07T05:31:56Z',
interval: 123,
widget_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
attributes: {},
status: 'not_started',
execution_weekdays: [],
time_window_start: '<string>',
time_window_end: '<string>',
time_zone: 'UTC',
enabled: false
})
};
fetch('https://api.example.com/api/v1/campaign/create?api_key=', 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/campaign/create?api_key=",
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>',
'type' => 'outbound_call',
'start_time' => '2023-11-07T05:31:56Z',
'interval' => 123,
'widget_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'attributes' => [
],
'status' => 'not_started',
'execution_weekdays' => [
],
'time_window_start' => '<string>',
'time_window_end' => '<string>',
'time_zone' => 'UTC',
'enabled' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/campaign/create?api_key="
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"outbound_call\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"interval\": 123,\n \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"attributes\": {},\n \"status\": \"not_started\",\n \"execution_weekdays\": [],\n \"time_window_start\": \"<string>\",\n \"time_window_end\": \"<string>\",\n \"time_zone\": \"UTC\",\n \"enabled\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
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/campaign/create?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"outbound_call\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"interval\": 123,\n \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"attributes\": {},\n \"status\": \"not_started\",\n \"execution_weekdays\": [],\n \"time_window_start\": \"<string>\",\n \"time_window_end\": \"<string>\",\n \"time_zone\": \"UTC\",\n \"enabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/campaign/create?api_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"outbound_call\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"interval\": 123,\n \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"attributes\": {},\n \"status\": \"not_started\",\n \"execution_weekdays\": [],\n \"time_window_start\": \"<string>\",\n \"time_window_end\": \"<string>\",\n \"time_zone\": \"UTC\",\n \"enabled\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "Data created successfully",
"meta": {},
"data": {
"name": "<string>",
"type": "outbound_call",
"start_time": "2023-11-07T05:31:56Z",
"interval": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {},
"status": "not_started",
"execution_weekdays": [],
"time_window_start": "<string>",
"time_window_end": "<string>",
"time_zone": "UTC",
"enabled": false,
"contacts": [],
"widget_name": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Campaign
Create Campaign
Create a new campaign
POST
/
api
/
v1
/
campaign
/
create
Create Campaign
curl --request POST \
--url 'https://api.example.com/api/v1/campaign/create?api_key=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "outbound_call",
"start_time": "2023-11-07T05:31:56Z",
"interval": 123,
"widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {},
"status": "not_started",
"execution_weekdays": [],
"time_window_start": "<string>",
"time_window_end": "<string>",
"time_zone": "UTC",
"enabled": false
}
'import requests
url = "https://api.example.com/api/v1/campaign/create?api_key="
payload = {
"name": "<string>",
"type": "outbound_call",
"start_time": "2023-11-07T05:31:56Z",
"interval": 123,
"widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {},
"status": "not_started",
"execution_weekdays": [],
"time_window_start": "<string>",
"time_window_end": "<string>",
"time_zone": "UTC",
"enabled": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: 'outbound_call',
start_time: '2023-11-07T05:31:56Z',
interval: 123,
widget_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
attributes: {},
status: 'not_started',
execution_weekdays: [],
time_window_start: '<string>',
time_window_end: '<string>',
time_zone: 'UTC',
enabled: false
})
};
fetch('https://api.example.com/api/v1/campaign/create?api_key=', 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/campaign/create?api_key=",
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>',
'type' => 'outbound_call',
'start_time' => '2023-11-07T05:31:56Z',
'interval' => 123,
'widget_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'attributes' => [
],
'status' => 'not_started',
'execution_weekdays' => [
],
'time_window_start' => '<string>',
'time_window_end' => '<string>',
'time_zone' => 'UTC',
'enabled' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/campaign/create?api_key="
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"outbound_call\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"interval\": 123,\n \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"attributes\": {},\n \"status\": \"not_started\",\n \"execution_weekdays\": [],\n \"time_window_start\": \"<string>\",\n \"time_window_end\": \"<string>\",\n \"time_zone\": \"UTC\",\n \"enabled\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
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/campaign/create?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"outbound_call\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"interval\": 123,\n \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"attributes\": {},\n \"status\": \"not_started\",\n \"execution_weekdays\": [],\n \"time_window_start\": \"<string>\",\n \"time_window_end\": \"<string>\",\n \"time_zone\": \"UTC\",\n \"enabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/campaign/create?api_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"outbound_call\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"interval\": 123,\n \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"attributes\": {},\n \"status\": \"not_started\",\n \"execution_weekdays\": [],\n \"time_window_start\": \"<string>\",\n \"time_window_end\": \"<string>\",\n \"time_zone\": \"UTC\",\n \"enabled\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "Data created successfully",
"meta": {},
"data": {
"name": "<string>",
"type": "outbound_call",
"start_time": "2023-11-07T05:31:56Z",
"interval": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {},
"status": "not_started",
"execution_weekdays": [],
"time_window_start": "<string>",
"time_window_end": "<string>",
"time_zone": "UTC",
"enabled": false,
"contacts": [],
"widget_name": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Your API KeyHTTPBearer
Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.
Body
application/json
Available options:
outbound_call Available options:
not_started, to_be_run, in_progress, paused, cancelled, completed Was this page helpful?