opt out a phone number of sms messages

API Docs by APIMATIC

Opt Out a Phone Number of SMS Messages

Use this method to opt out a customer phone number of SMS and MMS messages. A phone number can be opted out of SMS and MMS messages carrying a specific Sender ID. Using this API you can also block all outbound messages sent to a specific number.

This endpoint requires authentication.

POST /messages/opt_outs
  • EXPLORER
  • PARAMETERS
Endpoint Arguments*
Parameters*
body (MessageOpt-outRequest)*
opt_out (opt_out)*

Phone number to be opted out. Mandatory parameter.

Sender ID of which the phone number will be opted out. Optional parameter. If not specified, the phone number will be opted out of all SMS messages.

Server

Messaging

Response Type

Void

Errors

HTTP Status CodeError DescriptionException Class
403
Request failed. Outbound SMS messaging service is disabled.
422
The number was not opted out because of an error
Default
Request failed. Outbound SMS messaging service is disabled.
curl -X POST \
  --url 'https://api.wavix.com/v2/messages/opt_outs?appid=appid' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "opt_out": {
    "number": "41795703072"
  }
}'