Cancel a contact
Stops calling one contact that’s waiting: one not called yet, or one waiting for its next retry after a call nobody picked up. Handy when the reason for the call has gone away, like a cart that turned into an order. Set contact_id to the id you gave the row.
The contact becomes cancelled and isn’t called again. Its attempts and last call stay on the list and in the report, and the campaign no longer waits for it. A call that’s already ringing or in conversation is never cut off: you get 409 contact_in_call, so try again once it ends. Cancelling twice answers the same contact, so a retried request is safe. Works while the campaign is draft, paused or running. To call a cancelled contact after all, use Call a contact again.
Authorizations
Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.
Path Parameters
The campaign's id (cmp_…).
The contact's id: yours if you sent one, otherwise the one the campaign assigned.
Response
Cancelled