Campaigns
Pause Campaign
Temporarily pause an active campaign
POST
/
api
/
campaigns
/
{campaign_id}
/
pause
Pause Campaign
curl --request POST \
--url https://api.vaanivoice.ai/api/campaigns/{campaign_id}/pause \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vaanivoice.ai/api/campaigns/{campaign_id}/pause"
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}/pause', 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}/pause",
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}/pause"
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}/pause")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vaanivoice.ai/api/campaigns/{campaign_id}/pause")
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_bodyPause Campaign
Temporarily pause a running campaign. Can be resumed later with/resume.
Path Parameters
string
required
UUID of the campaign to pause
Example Request
curl -X POST "https://api.vaanivoice.ai/api/campaigns/abc-123-xyz/pause" \
-H "X-API-Key: vaani_abc123..."
Response 200 OK
{
"id": "7edae6d7-2f23-41e3-9c34-061cc3171e8a",
"client_id": "e3e5b338-937e-4672-a700-1a1f5817a385",
"agent_id": "d665d65d-f1f1-4c23-aee2-0675bd3ec06f",
"campaign_name": "campaing api test",
"excel_blob_url": "https://vaani-uat-storage.s3.ap-south-1.amazonaws.com/campaigns/e3e5b338-937e-4672-a700-1a1f5817a385/16e07bf0-d971-4b7c-980a-094913f50768_Untitled spreadsheet - Sheet1 (5).csv",
"results_excel_blob_url": null,
"last_result_generated_at": null,
"campaign_status": "paused",
"contact_source_type": "csv",
"gsheet_config": null,
"days_of_week": "tuesday,thursday",
"post_processing_status": "pending_excel",
"time_range_from": "04:30:00Z",
"time_range_to": "14:29:00Z",
"max_retries": 1,
"retry_after_mins": 5,
"call_concurrency": 1,
"start_date": "2026-09-22T04:30:00",
"end_date": "2026-09-23T14:29:00",
"created_at": "2026-09-22T05:16:39.393250",
"updated_at": "2026-09-22T05:17:53.129961",
"notification_emails": null,
"webhook_url": null,
"per_call_webhook_url": null,
"webhook_id": null,
"perform_dnd_check": false
}
Behavior
- Ongoing calls complete normally
- No new calls are initiated
- Campaign can be resumed with
/resume - All progress is preserved
- A
campaign_pausedwebhook is sent - Pausing is accepted from any status except
cancelled, evencompleted. Pausing a completed campaign changes its status topaused, but the campaign cannot be resumed because its end date has passed, so avoid it
⌘I
Pause Campaign
curl --request POST \
--url https://api.vaanivoice.ai/api/campaigns/{campaign_id}/pause \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vaanivoice.ai/api/campaigns/{campaign_id}/pause"
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}/pause', 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}/pause",
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}/pause"
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}/pause")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vaanivoice.ai/api/campaigns/{campaign_id}/pause")
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