Skip to main content
PATCH
/
campaign
/
terminate
Terminate All Calls by Agent ID
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 '
{
  "agent_id": "<string>"
}
'
Stop all active calls for a specific AI agent across all campaigns. This is useful when you need to halt all operations for a particular agent.
Impact: This will terminate ALL active calls for the specified agent, regardless of which campaign they belong to.
​
X-API-KEY
string
required
Your Ringg AI API key.
​
agent_id
string
required
ID of the agent whose calls should be terminated. Example: 196d8d88-591e-4e08-8324-2f928d152fff

​
When to Use This

  • Agent Issues: When an agent has problems and needs to stop all calls
  • Emergency Stop: Quick way to halt all calls for a specific agent
  • Agent Maintenance: Before updating or modifying an agent configuration
  • Resource Management: When an agent is consuming too many resources

​
What Gets Terminated

✅ Calls that will be terminated:
  • Calls in “registered” status (queued and waiting)
  • Calls in “retry” status (scheduled for retry)
❌ Calls that won’t be affected:
  • Already completed calls
  • Calls currently in progress (connected)
  • Calls that haven’t started yet
Note: You can find your agent ID in the agent the top of your dashboard.