Skip to main content
POST
/
scheduled-calls
/
{id}
/
cancel
{
  "id": "<string>",
  "customerId": "<string>",
  "scheduledTime": "<string>",
  "status": "<string>",
  "callId": "<string>",
  "postProcessingFlags": [
    "<string>"
  ]
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

ID of scheduled call to cancel

Response

Scheduled call canceled

​
id
string

Identification number of the scheduled call

​
customerId
string

ID of the customer

​
scheduledTime
string

Scheduled time of the call

​
status
string

Status of the scheduled call

​
callId
string

Identification number of the call if the call has been executed

​
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