Campaigns
Start Campaign
Start a scheduled or paused campaign
POST
/
api
/
campaigns
/
{campaign_id}
/
start
Start Campaign
curl --request POST \
--url https://api.vaanivoice.ai/api/campaigns/{campaign_id}/start \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vaanivoice.ai/api/campaigns/{campaign_id}/start"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.vaanivoice.ai/api/campaigns/{campaign_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.vaanivoice.ai/api/campaigns/{campaign_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 => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.vaanivoice.ai/api/campaigns/{campaign_id}/start"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<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.vaanivoice.ai/api/campaigns/{campaign_id}/start")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vaanivoice.ai/api/campaigns/{campaign_id}/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyStart Campaign
Transition a campaign fromscheduled or paused to active.
Path Parameters
string
required
UUID of the campaign to start
Example Request
curl -X POST "https://api.vaanivoice.ai/api/campaigns/abc-123-xyz/start" \
-H "X-API-Key: vaani_abc123..."
Response 200 OK
{
"id": "abc-123-xyz",
"campaign_name": "Summer Promo 2024",
"campaign_status": "active",
"updated_at": "2026-07-01T14:30:00Z"
}
Valid State Transitions
| From Status | Can Start? |
|---|---|
scheduled | ✅ Yes |
paused / paused_out_of_range | ✅ Yes |
active | No-op, returns the campaign unchanged |
completed | ❌ Rejected in practice: the end date has passed (400, outside the campaign schedule) |
cancelled | ❌ 400, a cancelled campaign cannot change state |
Checks performed when activating
Starting (or resuming) a campaign fails if any of these checks does not pass:| Check | Failure |
|---|---|
Current date is inside from_date/to_date and the weekday is in days_of_week | 400 outside the campaign schedule |
| Current time is inside the calling window | 400 outside the calling hours |
| Wallet has sufficient balance | 402 insufficient balance |
| An outbound number is configured for the agent | 400 no outbound number |
⌘I
Start Campaign
curl --request POST \
--url https://api.vaanivoice.ai/api/campaigns/{campaign_id}/start \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vaanivoice.ai/api/campaigns/{campaign_id}/start"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.vaanivoice.ai/api/campaigns/{campaign_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.vaanivoice.ai/api/campaigns/{campaign_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 => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.vaanivoice.ai/api/campaigns/{campaign_id}/start"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<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.vaanivoice.ai/api/campaigns/{campaign_id}/start")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vaanivoice.ai/api/campaigns/{campaign_id}/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body