Start a campaign
curl --request POST \
--url https://api.kataven.ai/v1/api/v1/campaigns/{id}/start \
--header 'Authorization: <api-key>'import requests
url = "https://api.kataven.ai/v1/api/v1/campaigns/{id}/start"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.kataven.ai/v1/api/v1/campaigns/{id}/start', 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.kataven.ai/v1/api/v1/campaigns/{id}/start",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.kataven.ai/v1/api/v1/campaigns/{id}/start"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.kataven.ai/v1/api/v1/campaigns/{id}/start")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kataven.ai/v1/api/v1/campaigns/{id}/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"completed_at": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"id": "<string>",
"max_concurrent_calls": 123,
"name": "<string>",
"phone_number_id": "<string>",
"retries_per_contact": 123,
"retry_delay_seconds": 123,
"scheduled_at": "<string>",
"started_at": "<string>",
"status": "<string>"
}"<string>""<string>""<string>"Campaigns
Start a campaign
Flips the campaign from draft/paused to running. The dispatcher goroutine begins originating calls subject to per-tenant rate caps.
POST
/
api
/
v1
/
campaigns
/
{id}
/
start
Start a campaign
curl --request POST \
--url https://api.kataven.ai/v1/api/v1/campaigns/{id}/start \
--header 'Authorization: <api-key>'import requests
url = "https://api.kataven.ai/v1/api/v1/campaigns/{id}/start"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.kataven.ai/v1/api/v1/campaigns/{id}/start', 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.kataven.ai/v1/api/v1/campaigns/{id}/start",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.kataven.ai/v1/api/v1/campaigns/{id}/start"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.kataven.ai/v1/api/v1/campaigns/{id}/start")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kataven.ai/v1/api/v1/campaigns/{id}/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"completed_at": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"id": "<string>",
"max_concurrent_calls": 123,
"name": "<string>",
"phone_number_id": "<string>",
"retries_per_contact": 123,
"retry_delay_seconds": 123,
"scheduled_at": "<string>",
"started_at": "<string>",
"status": "<string>"
}"<string>""<string>""<string>"Authorizations
Headers
Tenant database. Required when using a Zitadel JWT.
Path Parameters
Campaign id

