Extra Features
      Back to home
      1. Knowledge Base
      2. LMS Sync & Call Logic
      3. Extra Features

      Global Unsubscribe

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

      The Global Unsubscribe feature allows you to collect and manage unsubscribe requests in your instance. This feature can be integrated through the API or the built-in unsubscribe form.

      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.

      Use the “Total Sync Rules” list to create rules for the unsubscribe data to be pinged into the E-Delivery and Opt-Intel contact lists. Each rule can be filtered by Product, Publisher, and Website.

      To add a new rule, click the “Add” button and fill in the following information:

      • Product: Select the Product from the drop-down list. To apply the rule for all products, select the “*” option.

      • Publisher: Select the Publisher from which the unsubscribe link-generated data is received. To apply the rule for all Publishers, select the “*” option.

      • Website: Enter the website address (string value, up to 254 symbols) the unsubscribe request is coming from.

      • List Type: Select the type of the list to send the unsubscribe data (email or phone number) according to the created rule:

        • E-delivery contact list.

        • E-delivery unsubscribe email list.

        • E-delivery unsubscribe SMS list.

        • Opt-Intel email list.

        • Opt-Intel phone list.

      • List ID(s): Enter the corresponding list IDs (up to three lists per rule) from E-delivery or Opt-Intel components according to the selected list type.

      Click the “Save” button to confirm the changes.

      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.

      The following parameters can be used in the unsubscribe form link:

      • Response Type (responseType): The type of request (API / HTML).

        • If the responseType=api, meaning that unsubscribe requests are submitted through API, the unsubscribe form will not be displayed. If the request is successful, the response is “1”. If both the email and phone number are missing, the response is “0”, and the request is denied.
          The API request example:

          (INSTANCE_URL)/unsubscribe/unsubscribe?responseType=api&productId=(productId)&website=(website)&fields=email,phoneNumber&email=(email)&phoneNumber=(phoneNumber)&customField1=(customField1)&customField2=(customField2)&customField3=(customField3)

           

        • If the responseType=html, the unsubscribe form will be displayed, and all the mandatory fields should be validated. If the request is successful, the "You successfully unsubscribed" message will be displayed.

      The HTML request example:

      (INSTANCE_URL)/unsubscribe/unsubscribe?productId=(id)&website=(website)&fields=email,phoneNumber,customField1,customField2,customField3&fieldLabel[customField1]=Country&fieldLabel[customField2]=City&fieldLabel[customField3]=Reason

      • Fields: The list of output fields separated by commas (email, phoneNumber, customField1, customField2, customField3).

      • Field Label (fieldLabel): The custom fields headers to display through the form in the fieldLabel[customField1]=Label1 format.

      • Email (email): The email is required if there is no phone number.

      • Phone Number (phoneNumber): The phone number is required if there is no email.

      • Custom Fields (customField1, customField2, customField3): Each field is displayed only if it is specified using the fieldLabel parameter.

      • Product ID (productId): The product identifier (the default value is zero). If the product identifier is not in the system, then the value of the parameter is productId=0.

      • UUID (uuid): The UUID is the unique Publisher identifier for reporting.

      • Publisher ID (pubID): The Publisher’s ID.

      • Website (website): The source website that generated the conversion.

      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.