curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/campaign/terminate" \
--header "X-API-KEY: $RINGG_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "call_ids": ["00000000-0000-4000-8000-000000000116"] }'
{ "message": "Calls terminated successfully!" }
Terminate Calls by Call IDs
Cancel specific queued or retry calls by their call IDs, from the call response, call history or webhooks, without stopping the rest of the campaign.
PATCH
/
campaign
/
terminate
curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/campaign/terminate" \
--header "X-API-KEY: $RINGG_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "call_ids": ["00000000-0000-4000-8000-000000000116"] }'
{ "message": "Calls terminated successfully!" }
string
required
Your Ringg AI API key.
string[]
required
The calls to cancel. Example:
["00000000-0000-4000-8000-000000000116", "00000000-0000-4000-8000-00000000010d"]curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/campaign/terminate" \
--header "X-API-KEY: $RINGG_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "call_ids": ["00000000-0000-4000-8000-000000000116"] }'
{ "message": "Calls terminated successfully!" }
registered and retry outbound calls created in the last 7 days are cancelled. A call already in progress is not hung up; it ends normally and is not retried.
Call IDs come from the call response (data.call_id), call history (id) and webhook payloads.
Errors
200is returned even when no call matched the ID; check the calls in call history.401:X-API-KEYis missing or invalid.422: no field, more than one way of choosing calls at once, or a field of the wrong type.
Was this page helpful?