Campaigns
Cancel Campaign
Immediately cancel a campaign (hard stop)
POST
/
api
/
campaigns
/
{campaign_id}
/
cancel
Cancel Campaign
curl --request POST \
--url https://api.vaanivoice.ai/api/campaigns/{campaign_id}/cancel \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vaanivoice.ai/api/campaigns/{campaign_id}/cancel"
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}/cancel', 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}/cancel",
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}/cancel"
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}/cancel")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vaanivoice.ai/api/campaigns/{campaign_id}/cancel")
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_bodyCancel Campaign
Immediately terminate a campaign. Ongoing calls are completed, but no new calls are initiated.Path Parameters
string
required
UUID of the campaign to cancel
Example Request
curl -X POST "https://api.vaanivoice.ai/api/campaigns/abc-123-xyz/cancel" \
-H "X-API-Key: vaani_abc123..."
Response 200 OK
{
"id": "e8632ffe-ce38-4ae9-8185-72ef708aaa51",
"client_id": "e3e5b338-937e-4672-a700-1a1f5817a385",
"agent_id": "26356732-d0f3-449a-9fe7-6339ae157687",
"campaign_name": "campaing api ",
"excel_blob_url": "https://vaani-uat-storage.s3.ap-south-1.amazonaws.com/campaigns/e3e5b338-937e-4672-a700-1a1f5817a385/d3c4c1dd-e52d-4b4e-92d1-fccf63b55dad_Untitled spreadsheet - Sheet1 (2) (1).csv",
"results_excel_blob_url": null,
"last_result_generated_at": null,
"campaign_status": "cancelled",
"contact_source_type": "csv",
"gsheet_config": null,
"days_of_week": "tuesday",
"post_processing_status": "pending_excel",
"time_range_from": "08:30:00Z",
"time_range_to": "14:29:00Z",
"max_retries": 1,
"retry_after_mins": 5,
"call_concurrency": 1,
"start_date": "2026-08-25T08:30:00",
"end_date": "2026-08-25T10:33:52.232273",
"created_at": "2026-08-25T10:26:31.403625",
"updated_at": "2026-08-25T10:33:52.232273",
"notification_emails": null,
"webhook_url": null,
"per_call_webhook_url": null,
"webhook_id": null,
"perform_dnd_check": false
}
Behavior
- Immediately stops initiating new calls
- Ongoing calls complete normally
- Status transitions to
cancelled - Cannot be resumed after cancellation
- No webhook event is sent for cancellation (there is no
campaign_cancelledevent) - Accepted from any status, including
completed. Cancelling a completed campaign regenerates its results file and sets the status tocancelled
Comparison: Stop vs Cancel
| Action | Timing | Can Resume? | Use Case |
|---|---|---|---|
| Stop | Immediate (status becomes completed) | ❌ No | Finish now and get results |
| Cancel | Immediate | ❌ No | Emergency termination |
| Pause | Immediate | ✅ Yes | Temporary suspension |
Cancellation is permanent. Use
/pause if you need to temporarily suspend the campaign.⌘I
Cancel Campaign
curl --request POST \
--url https://api.vaanivoice.ai/api/campaigns/{campaign_id}/cancel \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vaanivoice.ai/api/campaigns/{campaign_id}/cancel"
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}/cancel', 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}/cancel",
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}/cancel"
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}/cancel")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vaanivoice.ai/api/campaigns/{campaign_id}/cancel")
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