Skip to main content
POST
cURL

Overview

This endpoint stops outreach only. It cancels the customer’s pending communications and schedules, but their loans keep their servicing status and scheduled payments are not touched. To stop servicing entirely — including payments and the loan’s servicing status — use Cancel Loan Servicing or Cancel Customer Servicing in the collections API. To close an enrolled origination application, use Close Origination. This endpoint cancels all pending communications for a customer, including:
  • Scheduled Calls: All pending scheduled calls linked to the customer’s loans or call schedules
  • Scheduled Emails: All pending scheduled emails
  • Scheduled SMS: All pending scheduled SMS messages
  • Call Schedules: All active loan call schedules
  • Email Schedules: All active loan email schedules
  • SMS Schedules: All active loan SMS schedules
Only pending communications and active schedules are affected. Items already sent, completed, or cancelled are left as is and are not counted in the response.

Use Cases

  • Stop all outreach to a customer who has requested no contact
  • Cancel communications when a customer’s account is closed
  • Clear all pending communications before setting up a new schedule

Response

The response includes a count for each type of cancelled item and a totalCancelled sum, allowing you to verify what was cancelled. cancelledTasks is always 0: tasks are no longer cancelled directly, and cancelling the pending scheduled calls above covers them. The field remains in the response for compatibility. Because only pending items are cancelled, repeating the request returns zero counts and makes no further changes. An unknown customer id returns 404.

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

ID of customer whose communications should be canceled

Response

All communications canceled for customer

id
string
required

Customer ID (reference_id)

cancelledTasks
integer
required

Always 0. Tasks are no longer cancelled directly; the field remains for compatibility.

Example:

0

cancelledCalls
integer
required

Number of scheduled calls cancelled

Example:

3

cancelledEmails
integer
required

Number of scheduled emails cancelled

Example:

2

cancelledSms
integer
required

Number of scheduled SMS cancelled

Example:

1

cancelledCallSchedules
integer
required

Number of call schedules cancelled

Example:

1

cancelledEmailSchedules
integer
required

Number of email schedules cancelled

Example:

1

cancelledSmsSchedules
integer
required

Number of SMS schedules cancelled

Example:

0

totalCancelled
integer
required

Total number of items cancelled

Example:

13