Cancel a message dispatch

DELETE

/v1/api/dispatch/{dispatchId}

Allows cancellation of a scheduled message dispatch. A dispatch can only be cancelled up to 5 minutes before the scheduled date and time. Immediate dispatches cannot be cancelled.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

Responses

🟢200

Dispatch successfully cancelled

This response does not have a body.

🟠400

🟠401

🟠403

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://prod.your-api-server.com/v1/api/dispatch/' \
--header 'X-API-Key: <api-key>'

Response Example

400 - Example 1

null

Modified at 2026-08-11 10:19:42

Dispatch messages info

Get all templates