The Global Unsubscribe feature allows you to receive an unsubscribe request from email and SMS directly inside your system. This feature can be integrated through an API or the built-in unsubscribe form.

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

The unsubscribe form parameters:

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

    • If the responseType=api, the unsubscribe form will not be displayed, and the unsubscribing process will work immediately. If the request is successful - the response is “1”. If both an email and a phone number are missing - the response is “0”, and the request is denied.

      The API request example:

      (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:
      (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 identifier of the form that allows you to obtain the publisher’s ID for the reporting.

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

  • Website (website): The source website that produced 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 is already present in the database, then the unsubscribeCount + 1 counter will be updated for this entry in the reporting; otherwise, a new record will be added.

To view the unsubscribe report, go to the All Reports > Extras > Global Unsubscribe section. Read more about the Global Unsubscribe Report in the Knowledge Base.

Did this answer your question?