SMS and MMS

Create an opt-out

Changed on

Opts a phone number out of receiving messages from a Sender ID, a 10DLC campaign, or all outbound messages.

post/v3/messages/opt-outs

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v3/messages/opt-outs
  • Auth
    HTTP bearer

Request body

Example request

{
  "opt_out": {
    "number": "16419252149",
    "sender_id": "15072429497"
  }
}

Response

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

successboolean required

Indicates whether the request was successful.

Example response

{
  "success": true
}

Changes

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status