Skip to main content
PATCH
/
campaign
/
terminate
Terminate Calls by Numbers
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 '
{
  "mobile_numbers": [
    "<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 ALL active calls to specific phone numbers across ALL campaigns. This is the most comprehensive way to ensure certain numbers are no longer contacted.
Global Impact: This terminates calls to the specified numbers across ALL active campaigns, not just one campaign.
​
X-API-KEY
string
required
Your Ringg AI API key.
​
mobile_numbers
string[]
required
Array of mobile numbers to terminate calls for across all campaigns (max 100). Example: ["+918882876897", "+918882876898"]

​
When to Use This

  • Global Opt-Outs: Customers who want to stop ALL calls from your organization
  • Legal Compliance: Honor comprehensive do-not-call requests
  • Data Privacy: Implement “right to be forgotten” requests
  • Emergency Stops: Immediately halt all contact attempts to specific numbers
  • Account Closure: Stop all calls when customers close accounts

​
Number Format Requirements

  • ✅ Correct: +918882876897 (with country code)
  • ✅ Correct: +1234567890 (international format)
  • ❌ Wrong: 8882876897 (missing country code)

​
Limits & Constraints

  • Maximum: 100 numbers per request
  • Rate Limits: Standard API rate limits apply
Best Practice: Use this endpoint for definitive opt-outs. For temporary or campaign-specific issues, consider using the campaign-numbers endpoint instead.