Cancel All Scheduled Calls

{
  "canceledCount": 123,
  "scheduledCalls": [
    {
      "id": "<string>",
      "customerId": "<string>",
      "scheduledTime": "<string>",
      "status": "<string>",
      "callId": "<string>",
      "postProcessingFlags": [
        "<string>"
      ]
    }
  ]
}

POST

scheduled-calls

customer

{customerId}

cancel-all

{
  "canceledCount": 123,
  "scheduledCalls": [
    {
      "id": "<string>",
      "customerId": "<string>",
      "scheduledTime": "<string>",
      "status": "<string>",
      "callId": "<string>",
      "postProcessingFlags": [
        "<string>"
      ]
    }
  ]
}

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

Show child attributes

scheduledCalls.id

string

Identification number of the scheduled call

scheduledCalls.customerId

string

ID of the customer

scheduledCalls.scheduledTime

string

Scheduled time of the call

scheduledCalls.status

string

Status of the scheduled call

scheduledCalls.callId

string

Identification number of the call if the call has been executed

scheduledCalls.postProcessingFlags

string[]

Array of post-processing flags from the associated call. Common flags include: DNC (Do Not Call), COMPLAINT, MESSAGE_LEFT, VOICEMAIL_CONNECT, RPC (Right Party Contact), THIRD_PARTY_CONTACT, WRONG_NUMBER, DECEASED, INCARCERATED, MILITARY, BANKRUPTCY, CIP_PASSED, CIP_FAILED, TRANSFER, CALLBACK_REQUEST, and others

Cancel Scheduled Call Get Call by ID

⌘I

API Documentation

Endpoint Examples

Cancel All Scheduled Calls

Authorizations

Path Parameters

Response