Skip to main content
PATCH
/
campaign
/
terminate
Terminate Calls by Call IDs
curl --request PATCH \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/terminate \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "call_ids": [
    "<string>"
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ringg.ai/llms.txt

Use this file to discover all available pages before exploring further.

Stop individual calls by providing their unique call IDs. This gives you precise control over which calls to terminate.
Precision Required: Make sure you have the correct call IDs. Invalid IDs will be ignored.
​
X-API-KEY
string
required
Your Ringg AI API key.
​
call_ids
string[]
required
Array of call IDs to terminate. Example: ["86815974-8a87-4e32-9953-aca4f97868ab", "9ab99d2d-595c-4ca1-bab7-07d13f253156"]

​
When to Use This

  • Selective Termination: Stop only specific problematic calls
  • Quality Control: Terminate calls that aren’t performing well
  • Customer Requests: Stop calls to specific contacts who requested removal
  • Targeted Control: Fine-grained call management

​
How to Get Call IDs

You can find call IDs from:
  • Call History API: Use the Get Call History endpoint
  • Real-time Monitoring: Dashboard call monitoring section
  • Webhook Notifications: Call status updates include call IDs
  • Campaign Reports: Export campaign data to get call IDs
Tip: You can terminate up to 100 calls in a single request for efficient bulk operations.