Create a new scheduled campaign
curl --request POST \
--url https://api.cleartalk.ai/campaigns/save-campaign \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agent_id": 20,
"agentname": "Agent Name",
"batchQuantity": 100,
"repeatAfter": 100,
"active": true,
"selected_tag": "Tag",
"index": 0,
"start_call": "2021-01-01",
"end_call": "2021-01-01",
"campaign_name": "Campaign Name",
"add_tag": "Tag",
"user_id": 0,
"maxLimit": 0,
"GHLCampaign": false,
"NumberlimitCallback": 0,
"working_hours": [],
"disposition": []
}
'import requests
url = "https://api.cleartalk.ai/campaigns/save-campaign"
payload = {
"agent_id": 20,
"agentname": "Agent Name",
"batchQuantity": 100,
"repeatAfter": 100,
"active": True,
"selected_tag": "Tag",
"index": 0,
"start_call": "2021-01-01",
"end_call": "2021-01-01",
"campaign_name": "Campaign Name",
"add_tag": "Tag",
"user_id": 0,
"maxLimit": 0,
"GHLCampaign": False,
"NumberlimitCallback": 0,
"working_hours": [],
"disposition": []
}
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({
agent_id: 20,
agentname: 'Agent Name',
batchQuantity: 100,
repeatAfter: 100,
active: true,
selected_tag: 'Tag',
index: 0,
start_call: '2021-01-01',
end_call: '2021-01-01',
campaign_name: 'Campaign Name',
add_tag: 'Tag',
user_id: 0,
maxLimit: 0,
GHLCampaign: false,
NumberlimitCallback: 0,
working_hours: [],
disposition: []
})
};
fetch('https://api.cleartalk.ai/campaigns/save-campaign', 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.cleartalk.ai/campaigns/save-campaign",
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([
'agent_id' => 20,
'agentname' => 'Agent Name',
'batchQuantity' => 100,
'repeatAfter' => 100,
'active' => true,
'selected_tag' => 'Tag',
'index' => 0,
'start_call' => '2021-01-01',
'end_call' => '2021-01-01',
'campaign_name' => 'Campaign Name',
'add_tag' => 'Tag',
'user_id' => 0,
'maxLimit' => 0,
'GHLCampaign' => false,
'NumberlimitCallback' => 0,
'working_hours' => [
],
'disposition' => [
]
]),
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.cleartalk.ai/campaigns/save-campaign"
payload := strings.NewReader("{\n \"agent_id\": 20,\n \"agentname\": \"Agent Name\",\n \"batchQuantity\": 100,\n \"repeatAfter\": 100,\n \"active\": true,\n \"selected_tag\": \"Tag\",\n \"index\": 0,\n \"start_call\": \"2021-01-01\",\n \"end_call\": \"2021-01-01\",\n \"campaign_name\": \"Campaign Name\",\n \"add_tag\": \"Tag\",\n \"user_id\": 0,\n \"maxLimit\": 0,\n \"GHLCampaign\": false,\n \"NumberlimitCallback\": 0,\n \"working_hours\": [],\n \"disposition\": []\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.cleartalk.ai/campaigns/save-campaign")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": 20,\n \"agentname\": \"Agent Name\",\n \"batchQuantity\": 100,\n \"repeatAfter\": 100,\n \"active\": true,\n \"selected_tag\": \"Tag\",\n \"index\": 0,\n \"start_call\": \"2021-01-01\",\n \"end_call\": \"2021-01-01\",\n \"campaign_name\": \"Campaign Name\",\n \"add_tag\": \"Tag\",\n \"user_id\": 0,\n \"maxLimit\": 0,\n \"GHLCampaign\": false,\n \"NumberlimitCallback\": 0,\n \"working_hours\": [],\n \"disposition\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/campaigns/save-campaign")
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 \"agent_id\": 20,\n \"agentname\": \"Agent Name\",\n \"batchQuantity\": 100,\n \"repeatAfter\": 100,\n \"active\": true,\n \"selected_tag\": \"Tag\",\n \"index\": 0,\n \"start_call\": \"2021-01-01\",\n \"end_call\": \"2021-01-01\",\n \"campaign_name\": \"Campaign Name\",\n \"add_tag\": \"Tag\",\n \"user_id\": 0,\n \"maxLimit\": 0,\n \"GHLCampaign\": false,\n \"NumberlimitCallback\": 0,\n \"working_hours\": [],\n \"disposition\": []\n}"
response = http.request(request)
puts response.read_bodyCampaigns
Create a new scheduled campaign
POST
/
campaigns
/
save-campaign
Create a new scheduled campaign
curl --request POST \
--url https://api.cleartalk.ai/campaigns/save-campaign \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agent_id": 20,
"agentname": "Agent Name",
"batchQuantity": 100,
"repeatAfter": 100,
"active": true,
"selected_tag": "Tag",
"index": 0,
"start_call": "2021-01-01",
"end_call": "2021-01-01",
"campaign_name": "Campaign Name",
"add_tag": "Tag",
"user_id": 0,
"maxLimit": 0,
"GHLCampaign": false,
"NumberlimitCallback": 0,
"working_hours": [],
"disposition": []
}
'import requests
url = "https://api.cleartalk.ai/campaigns/save-campaign"
payload = {
"agent_id": 20,
"agentname": "Agent Name",
"batchQuantity": 100,
"repeatAfter": 100,
"active": True,
"selected_tag": "Tag",
"index": 0,
"start_call": "2021-01-01",
"end_call": "2021-01-01",
"campaign_name": "Campaign Name",
"add_tag": "Tag",
"user_id": 0,
"maxLimit": 0,
"GHLCampaign": False,
"NumberlimitCallback": 0,
"working_hours": [],
"disposition": []
}
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({
agent_id: 20,
agentname: 'Agent Name',
batchQuantity: 100,
repeatAfter: 100,
active: true,
selected_tag: 'Tag',
index: 0,
start_call: '2021-01-01',
end_call: '2021-01-01',
campaign_name: 'Campaign Name',
add_tag: 'Tag',
user_id: 0,
maxLimit: 0,
GHLCampaign: false,
NumberlimitCallback: 0,
working_hours: [],
disposition: []
})
};
fetch('https://api.cleartalk.ai/campaigns/save-campaign', 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.cleartalk.ai/campaigns/save-campaign",
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([
'agent_id' => 20,
'agentname' => 'Agent Name',
'batchQuantity' => 100,
'repeatAfter' => 100,
'active' => true,
'selected_tag' => 'Tag',
'index' => 0,
'start_call' => '2021-01-01',
'end_call' => '2021-01-01',
'campaign_name' => 'Campaign Name',
'add_tag' => 'Tag',
'user_id' => 0,
'maxLimit' => 0,
'GHLCampaign' => false,
'NumberlimitCallback' => 0,
'working_hours' => [
],
'disposition' => [
]
]),
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.cleartalk.ai/campaigns/save-campaign"
payload := strings.NewReader("{\n \"agent_id\": 20,\n \"agentname\": \"Agent Name\",\n \"batchQuantity\": 100,\n \"repeatAfter\": 100,\n \"active\": true,\n \"selected_tag\": \"Tag\",\n \"index\": 0,\n \"start_call\": \"2021-01-01\",\n \"end_call\": \"2021-01-01\",\n \"campaign_name\": \"Campaign Name\",\n \"add_tag\": \"Tag\",\n \"user_id\": 0,\n \"maxLimit\": 0,\n \"GHLCampaign\": false,\n \"NumberlimitCallback\": 0,\n \"working_hours\": [],\n \"disposition\": []\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.cleartalk.ai/campaigns/save-campaign")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": 20,\n \"agentname\": \"Agent Name\",\n \"batchQuantity\": 100,\n \"repeatAfter\": 100,\n \"active\": true,\n \"selected_tag\": \"Tag\",\n \"index\": 0,\n \"start_call\": \"2021-01-01\",\n \"end_call\": \"2021-01-01\",\n \"campaign_name\": \"Campaign Name\",\n \"add_tag\": \"Tag\",\n \"user_id\": 0,\n \"maxLimit\": 0,\n \"GHLCampaign\": false,\n \"NumberlimitCallback\": 0,\n \"working_hours\": [],\n \"disposition\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/campaigns/save-campaign")
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 \"agent_id\": 20,\n \"agentname\": \"Agent Name\",\n \"batchQuantity\": 100,\n \"repeatAfter\": 100,\n \"active\": true,\n \"selected_tag\": \"Tag\",\n \"index\": 0,\n \"start_call\": \"2021-01-01\",\n \"end_call\": \"2021-01-01\",\n \"campaign_name\": \"Campaign Name\",\n \"add_tag\": \"Tag\",\n \"user_id\": 0,\n \"maxLimit\": 0,\n \"GHLCampaign\": false,\n \"NumberlimitCallback\": 0,\n \"working_hours\": [],\n \"disposition\": []\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API Key for authentication
Body
application/json
Agent id
Example:
20
Agent name
Example:
"Agent Name"
Batch quantity
Example:
100
Repeat after
Example:
100
Active
Example:
true
Tag
Example:
"Tag"
Index
Example:
0
Start call
Example:
"2021-01-01"
End call
Example:
"2021-01-01"
Campaign name
Example:
"Campaign Name"
Add tag
Example:
"Tag"
User id
Example:
0
Max limit
Example:
0
GHL campaign
Example:
false
Number limit callback
Example:
0
Working hours
Example:
[]
Disposition
Example:
[]
Response
201
Campaign created successfully
⌘I
