Create campaign
curl --request POST \
--url https://api.kupe.in/api/v1/campaigns \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caller_phone_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_name": "<string>",
"variable_names": [
"<string>"
],
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"call_flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"status": "not_started",
"batch_size": 123
}
'import requests
url = "https://api.kupe.in/api/v1/campaigns"
payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caller_phone_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_name": "<string>",
"variable_names": ["<string>"],
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"call_flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"status": "not_started",
"batch_size": 123
}
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: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
caller_phone_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
batch_name: '<string>',
variable_names: ['<string>'],
workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
call_flow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
status: 'not_started',
batch_size: 123
})
};
fetch('https://api.kupe.in/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.kupe.in/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([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'caller_phone_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'batch_name' => '<string>',
'variable_names' => [
'<string>'
],
'workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'call_flow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'status' => 'not_started',
'batch_size' => 123
]),
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.kupe.in/api/v1/campaigns"
payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"caller_phone_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"batch_name\": \"<string>\",\n \"variable_names\": [\n \"<string>\"\n ],\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"call_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"status\": \"not_started\",\n \"batch_size\": 123\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.kupe.in/api/v1/campaigns")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"caller_phone_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"batch_name\": \"<string>\",\n \"variable_names\": [\n \"<string>\"\n ],\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"call_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"status\": \"not_started\",\n \"batch_size\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kupe.in/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 \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"caller_phone_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"batch_name\": \"<string>\",\n \"variable_names\": [\n \"<string>\"\n ],\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"call_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"status\": \"not_started\",\n \"batch_size\": 123\n}"
response = http.request(request)
puts response.read_body{
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"call_flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caller_phone_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_name": "<string>",
"description": "<string>",
"status": "<string>",
"variable_names": [
"<string>"
],
"batch_size": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Campaigns
Create campaign
Create a new calling campaign (batch).
POST
/
api
/
v1
/
campaigns
Create campaign
curl --request POST \
--url https://api.kupe.in/api/v1/campaigns \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caller_phone_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_name": "<string>",
"variable_names": [
"<string>"
],
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"call_flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"status": "not_started",
"batch_size": 123
}
'import requests
url = "https://api.kupe.in/api/v1/campaigns"
payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caller_phone_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_name": "<string>",
"variable_names": ["<string>"],
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"call_flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"status": "not_started",
"batch_size": 123
}
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: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
caller_phone_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
batch_name: '<string>',
variable_names: ['<string>'],
workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
call_flow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
status: 'not_started',
batch_size: 123
})
};
fetch('https://api.kupe.in/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.kupe.in/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([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'caller_phone_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'batch_name' => '<string>',
'variable_names' => [
'<string>'
],
'workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'call_flow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'status' => 'not_started',
'batch_size' => 123
]),
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.kupe.in/api/v1/campaigns"
payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"caller_phone_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"batch_name\": \"<string>\",\n \"variable_names\": [\n \"<string>\"\n ],\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"call_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"status\": \"not_started\",\n \"batch_size\": 123\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.kupe.in/api/v1/campaigns")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"caller_phone_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"batch_name\": \"<string>\",\n \"variable_names\": [\n \"<string>\"\n ],\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"call_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"status\": \"not_started\",\n \"batch_size\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kupe.in/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 \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"caller_phone_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"batch_name\": \"<string>\",\n \"variable_names\": [\n \"<string>\"\n ],\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"call_flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"status\": \"not_started\",\n \"batch_size\": 123\n}"
response = http.request(request)
puts response.read_body{
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"call_flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caller_phone_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_name": "<string>",
"description": "<string>",
"status": "<string>",
"variable_names": [
"<string>"
],
"batch_size": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
KupeApiKeyBearerAuth
Kupe dashboard API key.
Body
application/json
Response
200 - application/json
Successfully created campaign.
Show child attributes
Show child attributes
⌘I

