Skip to main content
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"
}
'
{
  "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!"