Skip to main content
PATCH
/
campaign
/
terminate
Terminate Calls by Campaign 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 '
{
  "campaign_id": "<string>",
  "mobile_numbers": [
    "<string>"
  ]
}
'
Stop calls to specific phone numbers within a particular campaign. This gives you precise control to remove individual contacts from an active campaign.
Targeted Termination: This only affects the specified numbers within the given campaign. The same numbers in other campaigns will continue.
​
X-API-KEY
string
required
Your Ringg AI API key.
​
campaign_id
string
required
ID of the campaign. Example: 0b52ca2b-7767-4cb5-ac4c-b2a4f892a856
​
mobile_numbers
string[]
required
Array of mobile numbers to terminate within the campaign (max 100). Example: ["+918882876897", "+918882876898"]

​
When to Use This

  • Customer Requests: When contacts ask to be removed from calls
  • Data Quality: Remove invalid or problematic numbers from campaign
  • Compliance: Honor do-not-call requests for specific numbers
  • Selective Control: Keep campaign running but exclude certain contacts

​
Important Details

​
Number Format

  • Correct: +918882876897 with country code
  • Correct: +14155550100 in international format
  • Wrong: 8882876897 without country code

​
Limitations

  • Maximum: 100 numbers per request
  • Scope: Only affects specified campaign
  • Status: Only terminates registered/retry calls
Pro Tip: Use this endpoint to implement real-time opt-out functionality in your application. Customers can request removal and you can immediately stop their calls.