Email opt-out management email-opt-out
In order to provide the capability to recipients to unsubscribe from receiving email communications, you must always include an unsubscribe link in every email sent out to recipients. Learn more on privacy & opt-out management
To do this, you can:
-
Insert a link to a landing page into an email in order to enable users to unsubscribe from receiving communications from your brand. It can be:
-
A Journey Optimizer landing page. Learn how to add an opt-out landing page
-
A an external landing page. Learn how to add an external opt-out link
-
-
Add a one-click opt-out link into your email content. This link will enable your recipients to quickly unsubscribe from your communications, without being redirected to a landing page where they need to confirm their choice, which speeds up the unsubscribe process. Learn how to add a one-click opt-out link
-
Add an unsubscribe link in the email header. If the List-Unsubscribe option is enabled at the channel surface level, the corresponding emails sent with Journey Optimizer will include an unsubscribe link in the email header. Learn more on opt-out in email header
External opt-out opt-out-external-lp
Add an unsubscribe link add-unsubscribe-link
You first need to add an unsubscribe link into a message. To do this, follow the steps below:
-
Build your own unsubscription landing page.
-
Host it on the third-party system of your choice.
-
Create a message in a journey.
-
Select text in your content and insert a link using the contextual toolbar.
-
Select External Opt-out/Unsubscription from the Link type drop-down list.
-
In the Link field, paste the link to your third-party landing page.
-
Click Save.
Implement an API call for opt-out opt-out-api
To have your recipients opted out when they submit their choice from the landing page, you must implement a Subscription API call through Adobe Developer to update the corresponding profiles’ preferences.
This POST call is as follows:
Endpoint: https://platform.adobe.io/journey/imp/consent/preferences
Query parameters:
- params: contains the encrypted payload
- pid: encrypted profile ID
These three parameters will be included into the third-party landing page URL sent to your recipient:
Header requirements:
- x-api-key
- x-gw-ims-org-id
- x-sandbox-name
- authorization (user token from your technical account)
Request body:
{
"marketing": [
{
"type": "email",
"choice": "no",
"scope": "channel"
}
],
}
Journey Optimizer will use these parameters to update the corresponding profile’s choice through the Adobe Developer API call.
Send the message with unsubscribe link send-message-unsubscribe-link
Once you configured the unsubscribe link to your landing page and implemented the API call, your message is ready to be sent.
-
Send the message including the link through a journey.
-
Once the message is received, if the recipient clicks the unsubscribe link, your landing page is displayed.
-
If the recipient submits the form (here, by hitting the Unsubscribe button in your landing page), the profile data is updated through the API call.
-
The opted-out recipient is then redirected to a confirmation message screen indicating that opting out was successful.
As a result, this user will not receive communication from your brand unless subscribed again.
-
To check that the corresponding profile’s choice has been updated, go to Experience Platform and access the profile by selecting an identity namespace and a corresponding identity value. Learn more in the Experience Platform documentation.
In the Attributes tab, you can see the value for choice has changed to no.
One-click opt-out one-click-opt-out
To add an opt-out link in your email, follow the steps below.
-
Insert a link and select One click Opt-out as the type of link.
-
Enter the URL of the landing page where the user will be redirected once unsubscribed. This page is only here to confirm that opting out was successful.
note note NOTE If you enabled the List-Unsubscribe option at the channel surface level, this URL will also be used when users click the unsubscribe link in the email header. Learn more 
You can personalize your links. Learn more on personalized URLs in this section.
-
Select how you want to apply the opting out: at the channel, identity, or subscription level.
- Channel: The opt-out applies to future messages sent to the profile’s target (i.e. email address) for the current channel. If several targets are associated with a profile, the opt-out applies to all targets (i.e. email addresses) in the profile for that channel.
- Identity: The opt-out applies to future messages sent to the specific target (i.e. email address) being used for the current message.
- Subscription: The opt-out applies to future messages associated with a specific subscription list. This option can only be selected if the current message is associated with a subscription list.
-
Save your changes.
Once your message is sent through a journey, if a recipient clicks the opt-out link, their profile is immediately opted out.
Unsubscribe link in email header unsubscribe-header
If the List-Unsubscribe option is enabled at the channel surface level, the corresponding emails sent with Journey Optimizer will include an unsubscribe link in the email header.
For example, the unsubscribe link will display like this in Gmail:
The unsubscribe address is the default Mailto (unsubscribe) address displayed in the corresponding channel surface. Learn more
To set a personalized unsubscribe URL, insert a one-click opt-out link into the email message content and enter the URL of your choice. Learn more
Depending on the email client, clicking the unsubscribe link from the header can have the following impacts:
-
The unsubscribe request is sent to the default unsubscribe address.
-
The recipient is directed to the landing page URL that you specified when adding the opt-out link to your message.
note note NOTE If you do not add a one-click opt-out link into your message content, no landing page will be displayed. -
The corresponding profile is immediately opted out and this choice is updated in Experience Platform. Learn more in the Experience Platform documentation.