Source: https://vaultcrmhelp.veeva.com/doc/Content/CRM_topics/Multichannel/ApprovedEmail/CreatingContent/ConfigurableUnsubscribe.htm ## Adding and Customizing Unsubscribe Links Approved Email provides a built-in email unsubscribe solution that respects recipient preferences and complies with anti-spam regulations present in some markets. Links are generated and included in Approved Emails when the [{{unsubscribe\_product\_link}}](ConfigTokens.htm#%7B%7Bunsubs) token is included in a template of a sent email. Content creators can customize the provided pages to better control branding, translation, and wording of the unsubscribe page. This functionality is supported on all record types except Receipt and Double Opt In. **Who can use this feature?** * Content Creation Users — Browser * [Controlling the Language of Default Unsubscribe Pages](#Controlling) * [Customizing the Unsubscribe Pages](#Customizing) * Users require an Approved Email license ### Configuring Unsubscribe Links for [![Closed](../../../../../Skins/Default/Stylesheets/Images/transparent.gif)Content Creation Users](#) 1. Grant Content Creators the following permissions: | Object | Object Permissions | Object Types | Fields | Field Permissions | | --- | --- | --- | --- | --- | | message\_\_v | CRU | n/a | * message\_language\_\_v | Edit | 2. Ensure **Unsubscribed All** and **Preferences Modified** are added as selected values for the Activity (event\_type\_\_v) field on the Email Activity object type. [![Closed](../../../../../Skins/Default/Stylesheets/Images/transparent.gif)Approved Email Integration Users](#) 1. Grant Approved Email Integration Users the following permissions: | Object | Object Permissions | Object Types | Fields | Field Permissions | | --- | --- | --- | --- | --- | | message\_\_v | R | n/a | * message\_language\_\_v | Read | 2. Ensure **Unsubscribed All** and **Preferences Modified** are added as selected values for the Activity (event\_type\_\_v) field on the Email Activity object type. ### Using and Customizing Unsubscribe Links as [![Closed](../../../../../Skins/Default/Stylesheets/Images/transparent.gif)Content Creation Users](#) #### Controlling the Language of Default Unsubscribe Pages By default, templates for the Unsubscribe pages are supplied in all of Vault CRM's supported languages. The HTML for the pages (Unsubscribe Landing page, Confirmation, and Cancellation page) are stored in the following Approved Email-category Veeva Messages: | Name | Description | | --- | --- | | UNSUBSCRIBE\_CANCEL\_CHANGES\_HTML | Used to hold the cancel confirmation HTML document displayed to the end user should the cancel button be clicked. | | UNSUBSCRIBE\_OPTION\_HTML\* | Used to house the HTML document displayed to the Approved Email recipient when the Unsubscribe link is clicked. Admins must update the CSS styling for the input class to include color: black; in order to display correctly on certain devices. | | UNSUBSCRIBE\_CONFIRMATION\_HTML | Used to house the HTML document displayed to the Approved Email recipient as a confirmation for the successfully executed Unsubscribe action. | | UNSUBSCRIBE\_MODIFY\_OPTIONS\_CONFIRMATION\_HTML | Used to house the modify options confirmation HTML document displayed to the end user during the unsubscribe process | \*In the HTML, dd class="detailProduct" and the dt class="productGroup", supports CSS styling for the content inside the {{productModList}} tag. Content Admins must set the language on the **message\_language\_\_v** field on the Veeva Message (message\_\_v) records used. The following logic determines which message\_\_v record is used for the Unsubscribe page: * The message\_\_v record with a message\_language\_\_v value matching the account’s language (account\_\_v.language\_\_v) * If one does not exist or the language of the account is null, the message\_\_v record with a message\_language\_\_v value matching the user’s language (user\_\_sys.language\_\_vr.admin\_key\_\_sys) is used * If one does not exist, the Unsubscribe page displays in English #### Customizing the Unsubscribe Pages The HTML for these pages can be customized by content creators, though all CSS styles must be inline. Images must be hosted on your own servers when referenced inside the HTML. Customers who have accounts with different preferred languages can translate the HTML code accordingly and store it in the Veeva Messages for those respective languages. For example, if an organization has some Accounts with the preferred language set to Spanish and others as French, the Admin can modify the landing pages for each language and then store it in the UNSUBSCRIBE\_OPTION\_HTML Veeva message for both languages. The language should be set on the message\_language\_\_v field on message\_\_v. When a recipient selects the unsubscribe link, the page corresponding to the preferred language displays. The default unsubscribe landing page contains the following actions: * Simple Unsubscribe – When the recipient selects the Submit button in the first section of the unsubscribe landing page, an opt-out record is created in Vault CRM for that account’s email address for the particular product for which email was sent * Modify Email Preferences – Enables the recipient to modify their preferences for the current product and other products. When the recipient selects the Submit button in the second section, opt-ins are created for all the selected products and product groups and opt outs are created for all not selected. If nothing is selected, opt outs for all products are created. * If the Cancel button is clicked, there is no change in the consent record for any products When customizing the Veeva Messages controlling these pages, ensure the following Unsubscribe Tokens are included as they drive functionality. #### Unsubscribe Tokens The following table describes the fragment tokens associated with the Unsubscribe Process: | Token | Description | Rendered Format | Required | | --- | --- | --- | --- | | {{submitUnsub}} | Renders as an unsubscribe button that is used as the action of an HTML form data for a simple unsubscribe. | Button | | | {{EmailAddressUnsub}} | Displays the email address associated with the unsubscribe request. | Label | | | {{emailProduct}} | Displays the Detail Product or Detail Group associated with the unsubscribe request. | Label | | | {{productModList}} | Displays a selection menu with all Detail Products and Detail Groups with Approved Document records in Vault CRM. Recipients can select which products or groups to unsubscribe from. Detail Products and Detail Groups restricted to the recipient do not display in this list. For information on customizing the products that display, see [Customizing Products or Content Types on the Unsubscribe Page](DisplayProducts.htm). | Label | | | {{submitPerfOptions}} | Enables recipients to modify their preferences. Used as the action attribute in the associated HTML form data. | Button | | | {{cancel}} | Creates a Cancel button. When recipients select this button, no information is saved and the Cancel Confirmation page displays. | Button | | | {{unsubscribeAll}} | Enables email recipients to unsubscribe from all Approved Email communications. This enables compliance in certain markets that require this option. | checkbox | | ### Related Topics [Customizing Products or Content Types on the Unsubscribe Page](DisplayProducts.htm) [One-Click Unsubscribe](../ManagingContent/OneClickUnsubscribe.htm)