Opt-outs

Update a customer's opt-outs

Changed on

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.

Customer.io also writes a consent record for each entry, with the collection point api.

put/v1/customers/{customer_id}/optouts

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/customers/{customer_id}/optouts
  • Auth
    HTTP bearer

Request body

Example request

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

Response

A successful request produces an empty response.

Changes