Stop Campaign

POST

api

campaigns

{campaign_id}

stop

Stop Campaign

curl --request POST \
  --url https://api.vaanivoice.ai/api/campaigns/{campaign_id}/stop \
  --header 'X-API-Key: <api-key>'

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.vaanivoice.ai/api/campaigns/{campaign_id}/stop', 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}/stop",
  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}/stop"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.vaanivoice.ai/api/campaigns/{campaign_id}/stop")

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

Stop a campaign. The status changes to completed immediately; this is not an end-of-day soft stop.

Path Parameters

string

required

UUID of the campaign to stop

Example Request

curl -X POST "https://api.vaanivoice.ai/api/campaigns/abc-123-xyz/stop" \
  -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": "completed",
  "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:32:22.597597",
  "created_at": "2026-08-25T10:26:31.403625",
  "updated_at": "2026-08-25T10:32:22.597597",
  "notification_emails": null,
  "webhook_url": null,
  "per_call_webhook_url": null,
  "webhook_id": null,
  "perform_dnd_check": false
}

Behavior

campaign_status becomes completed right away and end_date is set to the current time
No new calls are started
Calls already in progress finish normally
A campaign_completed webhook is sent and the results report is generated (then campaign_report_ready)
Restarting is not supported in practice: /start and /resume re-check the schedule, and a completed campaign’s end date is already in the past, so they are rejected with 400. Create a new campaign to run the contacts again
Allowed from any status except cancelled

Use /pause if you need to temporarily stop and resume later. Use /stop to finish the campaign now and get its results. Use /cancel to terminate it permanently.

Stop Campaign

curl --request POST \
  --url https://api.vaanivoice.ai/api/campaigns/{campaign_id}/stop \
  --header 'X-API-Key: <api-key>'

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.vaanivoice.ai/api/campaigns/{campaign_id}/stop', 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}/stop",
  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}/stop"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.vaanivoice.ai/api/campaigns/{campaign_id}/stop")

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

Overview

Campaigns

Agents

Calls

Stop Campaign

Stop Campaign

Path Parameters

Example Request

Response `200 OK`

Behavior

​Stop Campaign

​Path Parameters

​Example Request

​Response 200 OK

​Behavior

Stop Campaign

Path Parameters

Example Request

Response `200 OK`

Behavior