Skip to main content
POST
cURL
Cancels calls whose current status is PENDING for the customer identified by their external reference within the API key’s company. Calls in other statuses are not selected by this operation — including calls already dispatched (TASK_CREATED, PROCESSING). To cancel a dispatched call, use Cancel a Scheduled Call on it individually.

Response

canceledCount is the number of calls cancelled by this request, and scheduledCalls lists those calls with status CANCELLED. The operation is idempotent: repeating it (or calling it for a customer with no pending calls) succeeds with canceledCount: 0 and an empty scheduledCalls array. An unknown customer reference returns 404.

Parent cadence is not affected

This operation does not cancel the parent cadence — later schedule activity can still create new scheduled calls for the customer. Do not use it as an assumed replacement for a funded/stop upload. See Funded applications and stopping outreach before retiring an existing stop process. To stop outreach entirely, use Close Origination for enrolled origination applications, or Cancel Loan Servicing / Cancel All Communications for collections and outreach.

Authorizations

X-API-Key
string
header
required

Path Parameters

customerId
string
required

ID of customer whose scheduled calls should be canceled

Response

All scheduled calls canceled for customer

canceledCount
integer

Number of scheduled calls that were canceled

scheduledCalls
object[]

Array of canceled scheduled calls