Skip to main content
POST
/
messages
/
opt_outs
Unsubscribe a phone number from SMS messages
curl --request POST \
  --url 'https://api.wavix.com/v1/messages/opt_outs?appid=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "+15551234567",
  "sender_id": "fc34ba88-1eee-476e-b09e-dae63dc441e0"
}
'
{
  "success": true
}

Authorizations

​
appid
string
query
required

An API key to authorize your request

Body

application/json

A request to opt out a phone number from receiving further communications

A request to opt out a phone number from receiving further communications

​
opt_out
Optout · object
required
Example:
{
  "number": "16419252149",
  "sender_id": "15072429497"
}

Response

​
success
boolean
required

Indicates if the operation is successful

Example:

true