Skip to main content
DELETE
/
sms
/
{message_id}
{
  "success": true,
  "message_id": "<string>",
  "message": "<string>",
  "previous_status": "<string>",
  "new_status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.burki.dev/llms.txt

Use this file to discover all available pages before exploring further.

Cancel a queued SMS message before it is sent. Only messages still in queued status can be cancelled. Messages already sending or already sent cannot be cancelled.

​
Path Parameters

  • message_id (string, required): The Burki message ID returned by POST /sms/send.

​
Response

Response
{
  "success": true,
  "message_id": "8ad70ee5-3d47-4fa4-a6ab-c9f2238d5f54",
  "message": "SMS cancelled successfully",
  "previous_status": "queued",
  "new_status": "cancelled"
}
If the message cannot be cancelled, the endpoint returns success: false with the current status.
Response
{
  "success": false,
  "message_id": "8ad70ee5-3d47-4fa4-a6ab-c9f2238d5f54",
  "message": "Message is already sending",
  "previous_status": "sending",
  "new_status": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
message_id
string
required

Response

Successful Response

Response model for SMS cancel endpoint.

​
success
boolean
required
​
message_id
string
required
​
message
string
required
​
previous_status
string | null
​
new_status
string | null