Home » Introduction of Octopush SMS Gateway API » SMS API » Cancel an SMS on list

Cancel an SMS on list

DELETE
https://api.octopush.com/v1/public/sms-campaign-on-list/cancel

Encoding : UTF-8

Authentication

Your “api-key” and “api-login” must be added in the headers.

Definition

This service allows you to cancel a campaign that’s is going to be sent to a list.

Special parameters

FieldTypeDescription
ticket_numberstringThis is the ticket_number transmitted by Octopush after the call to the creation function

Example Curl

curl -X DELETE \ 
'https://api.octopush.com/v1/public/sms-campaign-on-list/cancel' \ 
-H 'Content-Type: application/json' \  
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \
-H 'cache-control: no-cache' \ 
-d '{
  "ticket_number": "vocal_xx0000xx0000xx"
}'

Command to copy/paste

curl -X DELETE 'https://api.octopush.com/v1/public/sms-campaign-on-list/cancel' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"ticket_number": "vocal_xx0000xx0000xx"}'

JSON Server Response

Succes : 204 NO CONTENT