POST
/
v3
/
messages
/
opt-outs
Create an opt-out
curl --request POST \
  --url https://api.wavix.com/v3/messages/opt-outs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "opt_out": {
    "number": "16419252149",
    "sender_id": "15072429497"
  }
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Body

application/json

Attributes for the new opt-out.

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

Response

Returns a success confirmation. The opt-out is created.

​
success
boolean
required

Indicates whether the request was successful.

Example:

true