Skip to main content
POST
/
customers
/
{id}
/
cancel-communications
cURL
curl --request POST \
  --url https://api.example.com/customers/{id}/cancel-communications \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "cancelledTasks": 5,
  "cancelledCalls": 3,
  "cancelledEmails": 2,
  "cancelledSms": 1,
  "cancelledCallSchedules": 1,
  "cancelledEmailSchedules": 1,
  "cancelledSmsSchedules": 0,
  "totalCancelled": 13
}

​
Overview

This endpoint cancels all pending communications for a customer, including:
  • Tasks: All PENDING and SKIPPED tasks
  • Scheduled Calls: All pending scheduled calls
  • 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

​
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 counts for each type of cancelled item, allowing you to verify what was cancelled.

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

Number of tasks cancelled

Example:

5

​
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