Using the One-click Unsubscribe Functionality

You can help users to opt-out of a single Purpose directly from the header or footer of your email communications implementing the One-click Unsubscribe mechanism. By enabling a seamless and efficient unsubscribe process, your business will be able to build better customer relationships and ensure compliance with email marketing regulations.

To set up a One-click Unsubscribe Link for Bulk Senders

One-click Unsubscribe Link in Email Header

In order to support HTTP unsubscribe requests from your customers, you can add the following headers to your email messages:

  1. List-Unsubscribe: <Insert Link here>

  2. List-Unsubscribe-Post: One-Click

Note:

One-click unsubscribe links included in the email header are compliant with RFC 8058.

This will enable your customers to opt-out of a single Purpose directly from their email application while being able to stay subscribed to other Purposes of their interest. When a Gmail user clicks the Unsubscribe Link in one of your communications, this action will appear as a receipt in the OneTrust application, showing the data subject's consent withdrawal from a specific Purpose. For more information, see Viewing Consent Receipts & Transactions.

The following URL can be used as the request URL in your external system so that when users click the Unsubscribe Link at the top of an email, you will be allowing them to update their preferences without further action.

Request URL

https://<hostname>/auth/v1/token/preferences/multipage/<preferenceCenterGuid>/unsubscribe/<purposeGuid>?tokenId=<dstoken>

Note:

For more information about the POST request format, see Signaling One-Click Functionality for List Email Headers.

hostname

A fully qualified domain name (FQDN)

preferenceCenterGuid

The unique identifier of a Preference Center

purposeGuid

The unique identifier of a Purpose

dstoken

The data subject token ID

One-click Unsubscribe Link in Email Footer

Additionally, you can include an Unsubscribe Link at the bottom of your email messages:

  1. On the Universal Consent & Preference Management menu, select Interfaces > Preference Centers. The Preference Centers screen appears.

  2. Click the link in the Name column for the Multi Page Preference Center you want to configure. The Builder tab on the Preference Center Details screen appears.

  3. Navigate to the Integrations tab.

  4. Select a Purpose and click the Copy button in the Unsubscribe Link field. Paste it in the URL and replace <tokenid> with the data subject token.



    Note:

    Data subject link tokens must be URL encoded to ensure proper functionality.

    The Purposes selection field displays Purposes belonging to the Preference Center that you are currently configuring. Only one Purpose can be selected per link.

After clicking the Unsubscribe Link, the user will be opted-out of that Purpose and notified with the following screen.

Note:

The following information should be kept in mind regarding branding settings:

  • The logo is pulled from the logo uploaded in the Sign-in Page section on the following menu: Global Settings > Email and Branding > Application branding.

    • Recommended ratio is 7:3

    • Default dimensions are 300 x 53px

    • Maximum dimensions are 350 x 150px



Note:

Translations for the following messages can be configured on the Translations tab. For more information, see Configuring Translations for a Multi Page Preference Center.

  • You have been successfully unsubscribed from + name of the Purpose

  • Sorry, we were unable to process your request

  • Manage your preferences

    • To configure the Manage your preferences link to redirect the user to the corresponding Preference Center, add the showManagePreferencesLink=true query parameter

Language will be selected according to the browser language. If a translation has not been defined for a specific language, the default language of the Preference Center will be displayed.

A receipt will appear in the OneTrust application showing the data subject's consent withdrawal from that specific Purpose. The Origin field in the Other details section will take the value EMAIL_CLIENT_ONE_CLICK indicating where the receipt originated.