The SMS Works API
  1. batch messages
The SMS Works API
  • auth
    • /auth/getApiKey
      GET
    • /auth/token
      POST
  • batch messages
    • /batch/schedule
      POST
    • /batch/send
      POST
    • /batch/{batchid}
      GET
    • /batches/schedule/{batchid}
      DELETE
  • credits
    • /credits/balance
      GET
  • messages
    • /message/flash
      POST
    • /message/schedule
      POST
    • /message/send
      POST
    • /messages
      POST
    • /messages/failed
      POST
    • /messages/inbox
      POST
    • /messages/schedule/{messageid}
      DELETE
    • /messages/{messageid}
      DELETE
    • /messages/{messageid}
      GET
  • utils
    • /utils/errors/{errorcode}
      GET
    • /utils/test
      GET
  1. batch messages

/batches/schedule/{batchid}

DELETE
/batches/schedule/{batchid}
batch messages
Cancels a scheduled SMS message
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://api.thesmsworks.co.uk/v1/batches/schedule/'
Response Response Example
200 - Example 1
{
    "messageid": 5620320,
    "status": "CANCELLED"
}

Request

Path Params
batchid
string 
required
The ID of the batch you would like returned

Responses

🟢200Success
application/json
Body
messageid
string 
required
Example:
5620320
status
string 
required
Example:
CANCELLED
🔴500Error
Modified at 2022-09-11 19:34:57
Previous
/batch/{batchid}
Next
/credits/balance
Built with