Cancel Scheduled SMS
You can either cancel a single scheduled SMS send or an entire scheduled SMS batch using their returned IDs.
Cancelling a Single SMS
DELETE /sms/send/{id}
DELETE
/sms/send/{id}
Request Data
Headers
X-Api-Key
required
string
The API Key for your Workspace.
Responses
200 OK
400 Bad Request
The scheduled SMS was successfully cancelled.
400 Bad Request
The SMS could not be found, or was not cancellable.
Cancelling an SMS Batch
DELETE /sms/send/bulk/{id}
DELETE
/sms/send/bulk/{id}
Request Data
Headers
X-Api-Key
required
string
The API Key for your Workspace.
Response Data
JSON Data
cancelledCount
number
The number of SMS messages that were cancelled.
reason
string (optional)
The reason for the amount of SMS being cancelled.
errors
string[] (optional)
Any errors that occurred during the cancellation.