Global Unsubscribe

Find out how you can enable the Global Unsubscribe feature to use the unsubscribe form and configure its parameters.

Global Unsubscribe is a feature that allows users to stop receiving all emails from an organization. It applies to all categories of communication, not just specific lists. This feature helps ensure compliance with regulations like GDPR and CAN-SPAM, which require organizations to respect user preferences and provide an easy way to opt out of all communications.

To enable this feature, go to the System Management > Project Settings section and select the “Global” tab. Enable the “Unsubscribe API & Reporting” option in the “Global Unsubscribe” sub-tab and click the “Save” button to complete.

To view the API Documentation, click the “API Documentation” button. You will be redirected to the section with the Global Unsubscribe API Doc.

To get and print the Global Unsubscribe API Doc as a PDF file, click the “Print to PDF” button.

To view the information about the unsubscribe widget, click the “Unsubscribe Widget” button.

The Unsubscribe Widget allows users to manage their email preferences and opt out of receiving communications from an organization. Found in emails or on websites, it provides options to unsubscribe from specific mailing lists or all emails (global unsubscribe). This ensures compliance with regulations like GDPR and CAN-SPAM by making it easy for users to control the emails they receive.

To copy the unsubscribe widget code, click the “Copy Code” button.

To add an unsubscribe link to the form on your website, go to the System Management > Products section, select the corresponding Product from the list, and click the "Settings" button in the "Actions" column. Select the "Additional Form Settings" tab and fill in the following fields:

Form Unsubscribe Link: Enter the URL (plain text or value=link) to add an unsubscribe link to your JS Form. The unsubscribe link will be removed from the form if the field is blank. If you have configured additional options for the form, each option should be added as a separate line. Example: ca=http://unsubscribewebsite.com
Additional Options for Form Unsubscribe Link: Enter the list of additional options (plain text or value=link) to display in the unsubscribe pop-up window. Each option should be added as a separate line. Example: ca=California.
Message before Additional Options: Enter the text (plain text) that will be displayed in the unsubscribe pop-up window.

Click the “Save” button to confirm.

To view the page with the form, go to the System Management > General > Pages section, select the corresponding page from the list, and click the “View” button in the “Actions” column.

Read more about the Pages section in the Knowledge Base article.

The additional parameters can be used for the unsubscribe form link. To view the list of parameters, click the “API Doc” button and check the “Fields” section of the Global Unsubscribe API Doc.

Note: If there is no value passed for any of the website parameters (email, phoneNumber, customField1, customField2, customField3), the request will be saved with the “NOT DEFINED” value.

Note: If the combination of the email + phoneNumber + website + productId fields has been found in the database, the unsubscribe counter will be updated for this entry in the reporting showing +1 request. Otherwise, a new record will be added with 1 in the counter.

To view the Global Unsubscribe report, go to the All Reports > Extras > Global Unsubscribe section.

Read more about the Global Unsubscribe Report in the Knowledge Base article.

Additionally, you can configure Event Tracking Rules based on your preferences to automate actions triggered by received global unsubscribe requests. To create rules for the unsubscribe data to be pinged into the E-Delivery, Opt-Intel contact lists, or available TPS services, click the “Add Rule” button, and fill in the following fields in the “Add Rule” pop-up window:

Trigger: Select the “[API] Global Unsubscribe” option.
Action: Select the action that should be performed by triggering the unsubscribe action (the event tracking type).

Click the “Next” button to proceed with further rule configuration.

Fill in the following fields in the pop-up window:

Product: Select the Product.
Publisher: Select the Publisher.
Unsubscribe Website: Enter the website address (string value, up to 254 symbols) from which the unsubscribe request is coming. Note: You should enter the URL only without protocol (Example test.com, not https://test.com)

Then complete the settings in the “Action Settings” block depending on the selected action (tracking rule).

The list of available actions (tracking types) along with the corresponding KB articles with more details on configuration is the following:

The list of global unsubscribe tracking rules contains the following information:

Id: The unique identification number of the record.
Trigger: The event that triggers the action.
Trigger Settings: Settings of the scope of the integration rule are applied to.
Action: The integration applied for the rule.
Action Settings: Settings of the rule.
Status: The status of the rule.
Created At: The date and time the rule was created.
Author: The user that set up the rule.