Campaigns

Cancel a single scheduled message

Best-effort cancel of a not-yet-sent delayed message. Success is only reported on a confirmed delete of the queued send job; if the sending worker reserves the job first, the cancel fails honestly and the message still sends. Reliable only while scheduled delay remains

post/cancel-sms/

Request

  • Base URL: http://api.smsfusion.com.au
  • URL: http://api.smsfusion.com.au/cancel-sms/
  • Auth: one of:
    • API key in query parameter key
    • HTTP basic

Query parameters

keystring required

API Key as generated from the <a href='https://www.smsfusion.com.au/admin/api/'>admin panel</a>

idinteger required

Message (transact) id (also accepted as a POST body field)

Response

Message will not send - confirmed cancel

successboolean
transactIdinteger

Changes

No recorded changes to this operation across all 1 revision of this API.