Customer.io
v1.0.0
OpenAPI 3.1.0

Update a customer's opt-outs

US region

Client Libraries
Shell Curl

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.

Path Parameters
  • customer_id
    Type: string
    required

    The ID of the customer you want to perform an operation against.

Query Parameters
  • id_type
    Type: stringenum

    The type of customer_id you want to use to reference a person. If you don't provide this parameter, we assume that the customer_id in your request is a person's id. You can use email and phone only if they're enabled as identifiers in your workspace settings; otherwise the request returns 400. Reference phone values in E.164 format, like +14155552671, and URL-encode the leading + as %2B.

    values
    • id
    • email
    • phone
    • cio_id
Body
application/json
  • optouts
    Type: array object[]
    required

    The senders and channels you want to opt the person out of, or back in to. Provide one entry per sender/channel.

Responses
  • 204

    A successful request produces an empty response.

  • 400

    The request is malformed—for example, it references an unknown channel.

  • 404

    The customer_id does not exist.

  • 429

    Your request is over the 10-per-second limit.

Request Example for put/v1/customers/{customer_id}/optouts
curl 'https://api.customer.io/v1/customers/12345/optouts?id_type=id' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "optouts": [
    {
      "from": "+15551234567",
      "optout": true,
      "channel": "sms"
    }
  ]
}'
No Body

A successful request produces an empty response.