Skip to main content
DELETE
Cancel scheduled messages
Stop messages you scheduled with Trigger Chat before they are sent. This works for WhatsApp, Web Chat and Email messages.

Endpoint

Authentication

Every request needs your workspace API key in the x-api-key header.
You can create an API key from your dashboard. See API Keys for details.

Path Parameters


Response

This API always returns 200. Check isCancelled in the response to see whether anything was cancelled.

Cancelled

The scheduled messages were stopped and won’t be sent.

Nothing to cancel

There are no pending messages for this conversation. The message may have already been sent, already been cancelled, or the sessionId may be incorrect.

Could not cancel

The message couldn’t be cancelled, usually because it is already being sent. reason gives more detail.

Response Fields


Errors


Code Examples

cURL

JavaScript

Python

Node.js (axios)

Authorizations

x-api-key
string
header
required

Authentication header containing API key from SubVerse dashboard.

Path Parameters

sessionId
string
required

The sessionId returned by Trigger Chat when the message was scheduled.

Example:

"a3f1c9e2-7b4d-4e8a-9c21-5d6e7f8a9b0c"

Response

Cancellation result

responseCode
integer
required

Always returns 200 value, with error or success response details in message.

message
string
required

Success or error message with description.

data
any | null

Additional details if available.