Skip to main content

Cancel a queued send

Cancel a queued SMS, iMessage, or WhatsApp send. Repeat calls are idempotent.
This does not unsend a message. If the send is already in flight, it may still go out. Delivery-confirmed messages throw with status 400.
A successful cancel appends text.cancelled / imessage.cancelled / whatsapp.cancelled to the tracking timeline and fires the matching webhook once. See Cancel a queued send for retry backoff and other API details.

conversations.cancel(message)

string
required
Message ID to cancel (text_…, imessage_…, or whatsapp_…). First argument.

Response

boolean
Always true on success. Repeat calls are idempotent.
string
The cancelled message ID.
object
Request metadata: id, timestamp, api_version, object.

Errors

Throws ContiguityError.