Installation

Installation

Install the package in a Trailhead playground, Sandbox or Production.
To install it in a playground, you can use the Playground Start app, click on the Install a Package, and paste in the package ID 04taj0000003GRdAAM Or log in to an org here: https://login.salesforce.com/packaging/installPackage.apexp?p0=04taj0000003GRdAAM

Set Up Your Experience Site

If you have not already created an Experience Cloud Site you want to host your unsubscribe link on, you need to create a new one. Follow these steps to do so:

1. In Setup, go to Digital Experiences >> All Sites.
2. Click New.
3. On the next page, titled “Choose the Experience You Love”, select Unsubscribe Link 4.0, then Get Started.
4. Enter a Name: “Unsubscribe.”
5. Add “Unsubscribe” at the end of the URL. CAPITALIZE THE U!!!
   1. Your settings at this step should look like this:

6. Click Create and wait for the system to finish creating your new site. It should redirect you to a page that looks like this:
   
   1. If it does not, or if you want to navigate to the right place in the future, go back to Setup >> Digital Experiences >> All Sites, and click Builder next to Unsubscribe.
7. From the new Experience page from step 6, click Builder.
8. Dismiss the popup welcome window.
9. Go to Settings (Gear icon on the left) and check Guest users can see and interact with the site without logging in.
   
10. You need to configure the Site’s user profile. On Settings, click on Unsubscribe Profile.
    
11. Go to Enabled Flow Access or Flow Access section. Click Edit.
    
12. Add four flows with the UnsubscribeLink namespace from the left column to the right. Click Save.
    
13. Go back to the last browser tab which should still be in the Experience Site Builder (Or navigate back to it, see step 6.a). Click Publish in the top right corner.
    
14. Click the Publish button on the pop-up.
15. Click on the icon in the top left that looks like a website.
16. Go to Administration.
17. Click Activate and then OK.

Clone, Edit and Assign Permission Set {#clone,-edit-and-assign-permission-set}

We need to make sure that the users who administer the system or send emails out of Salesforce that require an unsubscribe link have permission to do so.

1. Navigate back to the regular Salesforce setup and go to permission sets (Users >> Permission Sets).
2. Click on Clone next to the permission set Unsubscribe Link. Name it something like “CUSTOM Unsubscribe Link.”
3. Edit it to give read and edit access to the Email Opt Out checkbox field on the Contact and/or Lead objects depending on which objects you use.
   1. You can learn how to edit a permission set’s field access here.
4. Assign the permission set to your system administrators and any other user who will need to include the link in their emails.
   1. How to assign a permission set to a user.

Create an Organization Wide Email Address, If Applicable

If you plan to send a confirmation email when someone opts out (it will say something like “You successfully unsubscribed.”), then you need an Organization Wide Email Address. Instructions on how to set that up are here.

Strongly suggested updates: Page Layouts and Fields {#strongly-suggested-updates:-page-layouts-and-fields}

We recommend adding the fields this app uses to your Contact and/or Lead page layouts.

1. Edit your Contact and Lead page layouts.
   1. Add the Email Opt Out field.
   2. Add the Unsubscribe related list. In the related list editor, add the fields Unsubscribe Email, Created Date, and Status.
2. If you don’t know how to update page layouts, then be proud of yourself for getting this far in this complex package installation. Here are some instructions.

Run the Set Up Flow

1. Go to Flows in Setup.
2. Search for Unsubscribe Link Setup.
3. Run it and answer the questions.

Test It Out!

1. Wait until you get an email saying that your site has been published (this should happen fairly quickly after you publish for the first time).
2. Create one or more test contacts, and a few leads, with your email address. If you’re using existing records with your email address, make sure “Email Opt Out” is unchecked.
3. Test Method 1:
   1. On one of the Contact records, in the Activity Panel, select Email and Compose. (Or just click on the email address link).
      1. Insert the Unsubscribe Link Contact merge field into the email by selecting the { } icon.
      2. Insert the Unsubscribe Link Contact field.
      3. Send the email.
   2. Check your email and open the email you sent.
   3. Click the link which should say Click here to unsubscribe from all email from our organization. (except it will say the name of your organization!)
4. Test Method 2:
   1. Add the Unsubscribe Link Contact and Unsubscribe Link Lead to your page layouts. Click on the link from a contact or lead record.
5. If you have chosen to allow the recipient to confirm that they want to opt-out, the screen will look like this (but note this text has been modified).
6. The next page should look like this. (If you said in the custom metadata type that you don’t want a confirmation email, then the last sentence will not appear).

7. Look for the confirmation email, if applicable.
8. Open the contact record that you emailed and confirm the following:
   1. Email opt out is now checked.
   2. There is a new related Unsubscribe record and Status = Unsubscribed.
9. All of the contacts and leads with the same email address should also have Email opt-out checked.
10. Uncheck all of the Email Opt Out boxes and test again starting on the Lead object. Select the Unsubscribe Link Lead merge field in your email. Follow the steps above but for the Lead object.

A Note on Email Templates

Lightning Templates

The app works delightfully well with Lightning templates! Just select the merge field Unsubscribe Link Contact when adding fields from a Contact object, and Unsubscribe Link Lead for the Lead object.

Classic Templates

We have NOT included classic email templates or VisualForce email templates in this version. The merge field does not work in classic templates, but you can recreate it by making a formula field inside your visualforce template that mimics the functionality of the Unsubscribe Link fields. Here’s info on Visualforce email templates in Classic.

How to Uninstall

Latest Version

If you have any records from the Unsubscribe custom object, you’ll lose them by uninstalling.

1. Deactivate the Flows from Unsubscribe Link, Unsubscribe Contacts, Unsubscribe Leads, Unsubscribe Link Quick, Unsubscribe Link No RecordId (names will slightly vary based on the version you’re using).
2. Remove the flow from the Experience Site page called Unsubscribe. Deactivate your experience site.
3. From Setup, search for “Installed Packages” and uninstall.

Version 3.0 or earlier

If you have any records from the Unsubscribe custom object, you’ll lose them by uninstalling.

1. Deactivate the Flows: Unsubscribe Link, Unsubscribe Contacts, Unsubscribe Leads (names will slightly vary based on the version you’re using).
2. Open the record for your Site.
   1. Change the “Active Site Homepage” to any other Visualforce page in your system.
   2. Deactivate the site. Sorry but you are unable to delete Force.com Sites.
3. From Setup, search for “Installed Packages” and uninstall.

Optional: Add the Unsubscribe Page to an Existing Site {#optional:-add-the-unsubscribe-page-to-an-existing-site}

More info to come, but this is an option.

FYI: What’s New in This Version

1. Goodbye Site.com and hello Experience Site!
2. Goodbye exposing email addresses in the URL. That data is now gone and only the contact or lead ID is included in the link.
3. Goodbye confirmation page and hello one-click opt out! (This is optional but highly recommended).
4. Option: you can allow your recipients to type in their email address if the Unsubscribe Link doesn’t work with their email security settings. Be warned that this allows anyone with the link and any email address of your contact or lead to unsubscribe that email address.

To Do List

Changes needed or wanted:

• Flow clean ups:
  • It looks like the custom flow error handling no longer is necessary.
  • Clean up unused elements in the flow.
• Make sure everything has good descriptions.
• Standardize naming convention for all elements.