Skip to main content
PATCH
/
campaign
/
terminate
/
campaign-numbers
Terminate Specific Numbers in Campaign
curl --request PATCH \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/terminate/campaign-numbers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "campaign_id": "0b52ca2b-7767-4cb5-ac4c-b2a4f892a856",
  "mobile_numbers": [
    "+918882876897",
    "+918882876898"
  ]
}
'
{
  "message": "Calls terminated successfully!"
}

​
Terminate Campaign Numbers

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.

​
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
  • A/B Testing: Stop calls to control group numbers

​
Perfect For

​
Customer Opt-Outs

Quickly remove customers who requested to stop receiving calls: 
{
  "campaign_id": "0b52ca2b-7767-4cb5-ac4c-b2a4f892a856",
  "mobile_numbers": ["+918882876897", "+918882876898"]
}

​
Data Cleanup

Remove invalid or problematic numbers while keeping campaign active.

​
Compliance Management

Honor do-not-call requests without stopping entire campaign.

​
Important Details

​
Number Format

  • ✅ Include country code: +918882876897
  • ✅ Use international format: +1234567890
  • ❌ Don’t use local format: 8882876897

​
Limitations

  • Maximum: 100 numbers per request
  • Scope: Only affects specified campaign
  • Status: Only terminates registered/retry calls

​
What Happens

  • Immediate: Queued calls to these numbers are cancelled
  • Retry Calls: Scheduled retries are also cancelled
  • Other Campaigns: Same numbers in other campaigns continue
  • Completed Calls: Already finished calls remain in history
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.

​
Response

Successful termination returns: 
{
  "message": "Calls terminated successfully!"
}
The response doesn’t specify how many calls were actually terminated, but all matching calls for the provided numbers within the campaign will be stopped.

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

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

Body

application/json
​
campaign_id
string
required

(Required) ID of the campaign

Example:

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

​
mobile_numbers
string[]
required

(Required) Array of mobile numbers to terminate within the campaign (max 100)

Example:
["+918882876897", "+918882876898"]

Response

Calls terminated successfully.

​
message
string
Example:

"Calls terminated successfully!"