System Opt-Out/Opt-In

When a user is ingested first into the CE system, they can technically receive any message, through any channel (given that the technical requirements like having an email address etc. exist). Our system does not require an opt-In, but it does process an opt-out, if sent the proper way.

Opt-Out status

Every user has an opt-out-status, which per default is “false”, an opt-out would be marked as “true”. It usually is channel-specific (e.g. only for email, but not for sms), but can be for “all” as well (not recommended).

It is stored in a system user-trait that you can see in the user profile. Here are some examples how it could look like:

Default (not opted out)

Channel-Specific opt-outs

Per default it is not possible to segment for this user trait, but the system will automatically make sure that no message (depending on the channel) gets send out, unless its a Realtime Campaign that is marked as “transactional”.

How to opt-out

There are two ways to opt out a user:

1. via API endpoint (see User Management API 1.0 under “Opt-out management”)
2. via sending the system event “Opt Out”

Both ways will have the same technical result:

• the opt-out status will be set to “true”

• the system triggers the “Opt Out” event (incl. the timestamp when it happened)

Examples:

{
  "id": "88c5a896-28bb-44e9-850c-2bf60f01a0f9",
  "events": [
    {
      "event": "Opt Out",
			"channel.type":"ALL"
			}
    }
  ]
}

{
  "id": "88c5a896-28bb-44e9-850c-2bf60f01a0f9",
  "events": [
    {
      "event": "Opt Out",
			"channel.type":"MAIL"
			}
    }
  ]
}

Which is better?

Both ways have pros and cons.

1. API endpoint

For using the API endpoint, the user needs to be a “full” user, because the identifier is the external Id of the user. Therefore this can’t be used for so-called “Leads”, users that only have an email address, but no external Id (e.g. Newsletter subscriber, not full customer). But it is possible to request the status of a user with it (just not for a lead). And it is a short API call (example externalId): url: https://api.crossengage.io/users/88c5a896-28bb-44e9-850c-2bf60f01a0f9/optout-status?channelType=MAIL body:

{
  "optOut": true
}

2. Event

Sending the event instead has more pros than cons.

• the event can have more properties and its possible to add more information like that (works like any other event). url: https://api.crossengage.io/events body:

{
  "id": "88c5a896-28bb-44e9-850c-2bf60f01a0f9",
  "events": [
    {
      "event": "Opt Out",
			"channel.type":"MAIL",
			"properties": {
				"status":"opt out via xy"
			}
    }
  ]
}

• an external Id is not necessary, because an event can be send with an email address (plus business Unit if it exists) instead.

• it can get technically get used in segmentation or to trigger a RT campaign, just like any other event (although a campaign would not be a good idea in context)

• the only con is, that forgetting the channel might result in no system opt-out at all ("channel.type" is necessary for that)

Special case: mail.unsubscribe

mail.unsubscribe

This event is part of the response data CE gets from the ESP (Email Service Provider), similar to mail.open and mail.click.

If a user clicks on a regular unsubscribe link (or the unsubscribe-link provided by the list-unsubscribe-header), it will automatically send “mail.unsubscribe” to the CE system.

This event will trigger the change of the opt out-status for the channel “EMAIL” and the change will then trigger the “Opt Out”-event as described above.

(Re)Opt In

The API endpoint is the same, just the content needs to get set to “false” instead of “true”.

The event “Opt In” works pretty much the same way as “Opt Out”, just the name is different. It will set the opt out status automatically to “false”

But what happens if…

What happens when the event “Opt In” or “Opt Out” is send directly without a channel-type?

Nothing. The event can be used to trigger a RT campaign, or be used it in a segment, but the system itself does nothing. No update to the system trait will happen, because the system doesn’t recognize it as a system event without it.

What if a custom “opt out” is used?

The system functionalities don’t need to be used, especially if there is kind of a preference center like subscription model (e.g. different shops, topics etc.) and its possible to work only with custom user traits instead.

In that case segments need to be very explicitly contain the user traits and should always be included.

But it is important to know that system opt-outs can still happen, e.g. caused by the so-called list-unsubscribe-header. There needs to be a workaround to process these cases in place or these users are opted out forever, even after trying to opt in again. Only using the system functionalities will reverse it (see (Re)Opt In).