Under Self-Managed, you must provide an unsubscribe URL and an email ID. MoEngage adds these to the HTTPS URL and mail-to sections of the email header while sending any email. However, you will be responsible for further processing of un-subscriptions via this. Also, to be compliant, you must process un-subscriptions within 48 hours. You must pass the updated preference back to MoEngage so that we can automatically ignore the unsubscribed users in the future.

To configure the list-unsubscribe via the self-managed approach:

1. Log in to your MoEngage dashboard.
2. Navigate to Settings > Channels > Email settings > Sender Configuration tab.
3. Click the email connector.
4. Click the vertical ellipsis icon and click Edit.
5. Under One-click unsubscribe, click Self Managed.
   

Then, you must provide the following:

1. One-click unsubscribe URL: Provide a link that unsubscribes the users on confirmation. Make sure to add the parameters using JINJA to this URL so that you can identify the user who requested to unsubscribe and act accordingly. Also, ensure that this link has no redirection or landing page and does direct un-subscription instead.
   
   Please do note that if the added identifier has special characters like @, the standard URL encoding will be applied. Click here to know more.
   
   

   For example, If the provided link is https://www.abc.com/unsubscribe?emailAddress={{UserAttribute['Email (Standard)']|default('email')}}, then along with this a parameter from Moengage will be added to the HTTPS section of the email header & would look like below: 
   
   

   https://www.abc.com/unsubscribe?emailAddress=bob@bob.com&qmoe=abc123

    
   Here,

   • https://www.abc.com/unsubscribe?emailAddress is the URL that you have entered within One-click unsubscribe URL & emailAddress is the parameter with which you are identifying your users to manage preference.
   • bob@bob.com is the value of the JINJA provided as the value for the parameter
   • The qmoe is the parameter that is appended to the URL by MoEngage to identify the user & the campaign from which this request originated from our side.
     
     

   info	Information Make sure to have default value always while adding the parameters to the link and the identifier as well. For example, the value should be like: https://www.abc.com/unsubscribe?emailAddress={{UserAttribute['Email (Standard)']|default('email')}}

2. One-click unsubscribe email: Provide an email ID here which will get added to the mail-to section of the email header.

   When an email ID is provided, The User Identifier field appears and is for identification purposes. MoEngage customizes the email’s subject line sent from the ISP to include this in the base64 encrypted format so that you can parse through the subject, decode it from the base64 format, and thus identify the user that needs to be unsubscribed in a secure manner.
   
   While the User identifier’s value is subjective based on the way you identify your users, some example values that can be used are mentioned below. Also, note that these must be added using JINJA, the templating language used by MoEngage:

    

   User Identifier Example	JINJA Format
   ID	{{UserAttribute['ID']|default('ID')}}
   Email ID	{{UserAttribute['Email (Standard)']|default('email')}}

How to process the received request?

Whenever the user unsubscribes via the List unsubscribe method, you need to do the following:

1. If the request was handled by the ISP through the One-click URL:
   
   1. Identify the user who requested to unsubscribe using the parameters that you've added. 
      In our above example provided, the emailAddress parameter should help you identify the user and process the same.
   2. Next, execute the below public API by passing the qmoe parameter to help MoEngage update the subscription status of the user:
      

      https://api-0x.moengage.com/v1/emailunsubscribe?qmoe=<qmoe_parameter>

       

      • The 'X' in the API Endpoint URL refers to the MoEngage Data Center (DC). MoEngage hosts each customer in a different DC. You can find your DC number (value of X) and replace the value of 'X' in the URL by referring to the DC and API endpoint mapping here.
      • <qmoe_parameter>, as mentioned above is a parameter that will be appended to the URL by MoEngage to identify the user & the campaign. In the above example, qmoe_parameter is abc123.
2. If the request was handled by the ISP through the Mail-to Approach:
   1. Parse the Subject line of the email sent by the ISP to the inbox mentioned by you to identify the user and unsubscribe them from the list you manage. A sample subject line would look like below:
      

       

      Unsubscribe | cattr:YzlhZjVkYzUtYWRkMi00MTZkLTg4OTQtNWNlZmRkYTJjNDYw-WTRv4uSIgrZTVV5fJSvAZkS2smalAXvg8qX_0qz3AXdXNRHz.AwCwAo2OsppN0DGt2qd0R4qSg-5YLB5qTvuHp.2EIBfDrKmDauXjQXySNcGHo0w__OdsmU2_LAzK1aAynsczTVn.yuaRa.4MGgjQ-lq_KXmK.l7mgq17UL1WOZsjqPOJGzcrHTW3iZYOXt2O5Ikgwk9CJgO0Hg7Z8ZO3OewvzeED8BFN4fuAwyvkCV7yPQtHTMZ_coK_Yu42TPeysvhhgr0yFlLvrXIMsEolDk64xtNx8Ie76YcE

       

      • In the subject line above, you must parse through to find the sub-text that’s between cattr: and the first hyphen; that is, in this example, the sub-text you'll find is YzlhZjVkYzUtYWRkMi00MTZkLTg4OTQtNWNlZmRkYTJjNDYw. 
      • Then, decode this via the Base64 method to find the user who must be unsubscribed.
       
   2. To help MoEngage update the subscription status of the user, forward the email to the inbox, unsubscribe-DC0X@moengage.com.
      
      • Here the 'X' in the email id refers to the MoEngage Data Center (DC). MoEngage hosts each customer in a different DC. You can find your DC number (value of X) and replace the value of 'X' in the URL by referring to the DC and API endpoint mapping here.
      • You can always setup auto-forward of emails received in your inbox to make this easier. To setup the same, please refer below:
        • Yahoo
        • Microsoft
        • Gmail