Skip to main content
DELETE
Cancel a call
A call can be cancelled while it is waiting to be dialed: pending, retry (waiting for calling hours to open, or backing off after a busy or no-answer) or callback_requested (scheduled). Once a dial has started there is nothing to stop. You can also cancel waiting calls by hand from On-Demand activity on the campaign’s On-Demand tab in Studio.

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.

contactId
string<uuid>
required

The contact_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