Terminate All Calls in Campaign

PATCH

campaign

terminate

campaign

Terminate All Calls in Campaign

curl --request PATCH \
  --url https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "campaign_id": "0b52ca2b-7767-4cb5-ac4c-b2a4f892a856"
}
'

import requests

url = "https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign"

payload = { "campaign_id": "0b52ca2b-7767-4cb5-ac4c-b2a4f892a856" }
headers = {
    "X-API-KEY": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({campaign_id: '0b52ca2b-7767-4cb5-ac4c-b2a4f892a856'})
};

fetch('https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign', 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://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign_id' => '0b52ca2b-7767-4cb5-ac4c-b2a4f892a856'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <x-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign"

	payload := strings.NewReader("{\n  \"campaign_id\": \"0b52ca2b-7767-4cb5-ac4c-b2a4f892a856\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaign_id\": \"0b52ca2b-7767-4cb5-ac4c-b2a4f892a856\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"campaign_id\": \"0b52ca2b-7767-4cb5-ac4c-b2a4f892a856\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Calls terminated successfully!"
}

Terminate Campaign Calls

Stop all active calls within a specific campaign. This terminates all queued and retry calls for the entire campaign.

Campaign Impact: This will terminate ALL active calls in the specified campaign, affecting all contacts in that campaign.

When to Use This

Campaign Issues: When a campaign has problems and needs to be stopped
Content Problems: If the campaign script or agent has errors
Budget Management: When campaign costs exceed budget
Schedule Changes: If campaign timing needs to be adjusted
Quality Control: When campaign performance is poor

What Gets Terminated

✅ Calls that will be terminated:

All calls in “registered” status (queued and waiting)
All calls in “retry” status (scheduled for retry)
Affects ALL contacts within this specific campaign

❌ Calls that won’t be affected:

Calls from other campaigns
Already completed calls in this campaign
Calls currently in progress (connected)

How to Get Campaign ID

Find your campaign ID from:

Campaign Dashboard: Listed in your campaign management section
Campaign API: Use /campaign/all to list campaigns with IDs
Campaign Creation: Returned when you start a campaign
Reports: Campaign reports include the campaign ID

Note: After terminating a campaign, you can restart it later if needed using the original campaign configuration.

Use Cases

Emergency Stop

Quickly halt a problematic campaign:

# Stop campaign immediately
curl -X PATCH /campaign/terminate/campaign \
  -H "Content-Type: application/json" \
  -d '{"campaign_id": "0b52ca2b-7767-4cb5-ac4c-b2a4f892a856"}'

Budget Control

Stop campaigns that exceed budget limits before more calls are made.

Quality Issues

Halt campaigns with script problems or poor performance metrics.

Headers

X-API-KEY

string

required

(Required) Your Revenueable AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Body

application/json

campaign_id

string

required

(Required) ID of the campaign whose calls should be terminated

Example:

"0b52ca2b-7767-4cb5-ac4c-b2a4f892a856"

Response

Calls terminated successfully.

message

string

Example:

"Calls terminated successfully!"

Terminate Specific Numbers in CampaignTerminates calls to specific mobile numbers within a campaign. Useful for stopping calls to particular contacts in a campaign.

Terminate All Calls in Campaign

curl --request PATCH \
  --url https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "campaign_id": "0b52ca2b-7767-4cb5-ac4c-b2a4f892a856"
}
'

import requests

url = "https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign"

payload = { "campaign_id": "0b52ca2b-7767-4cb5-ac4c-b2a4f892a856" }
headers = {
    "X-API-KEY": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({campaign_id: '0b52ca2b-7767-4cb5-ac4c-b2a4f892a856'})
};

fetch('https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign', 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://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign_id' => '0b52ca2b-7767-4cb5-ac4c-b2a4f892a856'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <x-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign"

	payload := strings.NewReader("{\n  \"campaign_id\": \"0b52ca2b-7767-4cb5-ac4c-b2a4f892a856\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaign_id\": \"0b52ca2b-7767-4cb5-ac4c-b2a4f892a856\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.revenueable.ai/ca/api/v0/campaign/terminate/campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"campaign_id\": \"0b52ca2b-7767-4cb5-ac4c-b2a4f892a856\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Calls terminated successfully!"
}

Get Started

Webhooks Setup

API Reference

Terminate All Calls in Campaign

Terminate Campaign Calls

When to Use This

What Gets Terminated

How to Get Campaign ID

Use Cases

Emergency Stop

Budget Control

Quality Issues

Headers

Body

Response

​Terminate Campaign Calls

​When to Use This

​What Gets Terminated

​How to Get Campaign ID

​Use Cases

​Emergency Stop

​Budget Control

​Quality Issues

Headers

Body

Response

Terminate Campaign Calls

When to Use This

What Gets Terminated

How to Get Campaign ID

Use Cases

Emergency Stop

Budget Control

Quality Issues