Opt-outs

Update a customer's opt-outs

Opt a person out of, or back in to, specific senders and channels. Provide one entry per sender/channel in the optouts array.

Set optout to true to opt the person out of a sender, or false to opt them back in. The channel field is optional and defaults to sms.

This request is processed asynchronously; it may take a moment for changes to reflect in read requests.

put/v1/customers/{customer_id}/optouts

Request body

Example request

{
  "optouts": [
    {
      "from": "+15551234567",
      "optout": true,
      "channel": "sms"
    }
  ]
}

Response

A successful request produces an empty response.

Changes

Changed in 1 of the 3 revisions of this API.1

    • added the media type application/json for the response with the status

      response-media-type-added