Skip to main content
DELETE
Cancel a call by request ID
Use this when your system keeps the request_id rather than the contact_id. The rules are the same as Cancel a call.

Authorizations

X-API-Key
string
header
required

An API key from Manage → API Keys in Studio. See Authentication.

Path Parameters

campaignId
string<uuid>
required

The campaign's ID, copied from its On-Demand tab in Studio.

requestId
string<uuid>
required

The request_id returned when you placed the call.

Response

The request was processed. already_cancelled says whether this request cancelled the call.

success
boolean
required
data
object
required