Skip to main content

Unsubscribe Link

Updated
 
Table of Contents
  1. 1. Overview
  2. 2. To Create an Unsubscribe Link
      1. 2.1.1. Example
      2. 2.1.2. Testing the Link
  3. 3. Related

Overview

Email message content supports the %%UNSUB_HREF%% tag to automatically generate an unsubscribe link.  Alternately, you can generate an Unsubscribe Link to let your Contacts unsubscribe from a specific list with a single click.

To Create an Unsubscribe Link

  1. Go to CONTACTS > SUBSCRIPTION FORM WIZARD.
  2. Select a List.
  3. From Generate select 'Unsubscribe Link'.
  4. Enter a Goto URL for the landing page.  If no landing page is defined, the form will use the Landing Page defined in your List properties.  If no Landing Page is defined, the contact will see a default platform welcome page.
  5. Enter an Error Landing Page. If no landing page is defined, the form will use the Landing Page defined in your List properties.  If no Landing Page is defined, the contact will see a default platform error page.
  6. Click NEXT.
  7. Select the link code and paste into a text editor to customize it if necessary.
  8. Test the link, then place the link code iinto your message content.

Example

The following is an example of how the link code will appear, where [siteURL] is the URL of your domain, [slid] is the special list id, [format] is the preferred email format, [gotoURL] is the success Landing Page, and [errorURL] is the Error Landing Page.

%%set email = { {urlencode $email} }%% Click to <a href="http:// [siteURL]/bin/listctrl?c=unsubscribe&s=[slid]&e=%%$email%%&g=[gotoURL]&err=[errorURL]">Unsubscribe %%$email%%</a> from this list

The 'set' command at the beginning of the link code is used to encode a contact email address.  This is for cases where a contact has the '+' (plus) character in their email address.  While it is a valid character, it can cause URLs to break because the character is interpreted as a space in a hyperlink.

If you wish to use the link in your site instead of as part of your email message, you can leave out the 'set' command, then replace the %%$email%% tag with your site code to insert the contact email address.

Testing the Link

Once you have created a link, test it to ensure it is functioning as expected.  To test your subscription link:

  1. Login to your realm.
  2. Go to CONTACTS > SEARCH FOR CONTACT.
  3. Click ADD.
  4. Enter an Email address to create a test contact.  Click the Subscription tab and select the list to test against, then click SAVE.
  5. Copy the HTTP link portion from the link code.  For example:
    • http:// mydomain.com/bin/listctrl?c=unsubscribe&s=1234&e=%%$email%%&g=http:// mysite.com/goodbye.html&err=http:// mysite.com/error.html
  6. Replace the %%$email%% tag with your test email address.
  7. Paste the customized URL into your browser and click GO.  Verify the expected landing page is displayed.
  8. Login to your realm.
  9. Go to CONTACTS > SEARCH FOR CONTACT.
  10. Enter the Email address submitted above, then click SEARCH. 
  11. Double click the contact record to view the details.
  12. Verify the subscription was removed in the Subscription tab.

You can also test the link by adding the link code to your message content and then sending a copy of the message to yourself and clicking the link. The %%$email%% tag will automatically fill with the data from your contact record.

 

Related articles