Skip to navigation

Cancel a scheduled message

Cancels a single queued message for a contact. Get the message ID from List scheduled messages. The message is removed and never sent. Returns {"cancelled": 0} when the message is not queued (already sent, already cancelled, or not found).

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Path parameters

campaignIdstringRequired
contactIdentifierstringRequired

Contact phone number (E.164) or Apple ID email, URL-encoded (+ becomes %2B).

messageIdstringRequired
The message ID.

Response

Messages cancelled
cancelledintegerOptional
Number of queued messages that were cancelled.

Errors

400
Bad Request Error
500
Internal Server Error