Opt-outs

Lookup a customer's opt-outs

Changed on

Return a list of the senders and channels that a person has opted out of, across all channels.

An entry's presence in the optouts array means the person is opted out of that sender/channel. Use the PUT /v1/customers/{customer_id}/optouts endpoint to opt a person out of, or back in to, specific senders.

get/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

Response

Returns the person's opt-outs across channels.

Example response

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

Changes