Approved Email Configuration Tokens
Approved Email tokens are used for personalization by customers and for limited personalization by users. Personalization values are pulled from the Account and User objects and allow emails to contain personalized content. Configuration tokens enable specific behavior prior to an email being sent.
Do not include tokens in commented out sections of Approved Email content.
All tokens are case sensitive.
Approved Email Tokens fall into one of the following categories:
- Inserting Email Fragments and Template Fragments
- Content Tokens
- Standard Tokens
- Object Reference Tokens
- Sent Email Related Tokens
- Functionality Tokens
- Vault Tokens
- User Input Tokens
- Text Tokens
- Picklist Tokens
- Signature Transaction Receipt Tokens
- Consent Capture Tokens
- Unsubscribe Tokens
- Unsubscribe Link Tokens
- Unsubscribe Page Tokens
- Website Tokens
Tokens that can be used in Email Fragments can also be used in Master Email Fragments.
Do not use multiple lines when adding tokens to the Subject Field.
Do not use Approved Email tokens in unsupported entry points or content types. This may result in unexpected behavior.
Inserting Email Fragments and Template Fragments
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
{{insertEmailFragments}} |
Defines where fragments are inserted in templates. This token must be inserted in an empty <table> tag in the Email Template. Do not insert multiple {{insertEmailFragments}} tokens into the same Email Template. See Creating Approved Email Templates for more information about template requirements. |
All except Receipts and Double Opt In |
|
{{insertEmailFragments[Minimum,Maximum]}} |
Defines the minimum and maximum number of fragments end users can add to a template. For example, {{insertEmailFragments[2,4]}} requires end users to select between two and four fragments to add to the email. Do not insert multiple {{insertEmailFragments[Minimum,Maximum]}} tokens into the same Email Template. |
All except Receipts and Double Opt In |
|
{{emailTemplateFragment}} |
Inserts an HTML snippet that is managed by the Vault Email Template Fragment document type. Typically used to append a standard disclaimer or ISI to the end of the selected template. |
All |
|
{{insertEmailBuilder}} |
Defines the section in an Email Template where Email Builder Cells are inserted. This token must be inserted in an empty <table> </table> tag in the Email Template. |
All except Events Management, Receipts, and Double Opt-In |
|
Content Tokens
Content tokens are tokens that add specific content or add links to related content.
Select tokens with blue names to play an instructional video on the token.
Tokens in Email Fragment URLs are not accessible in Preview mode.
Standard Tokens
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
{{accTitle}} |
Inserts Account salutation |
All |
|
{{accFname}} |
Inserts Account first name |
All |
|
{{accLname}} |
Inserts Account last name |
All |
|
{{accCredentials}} |
Inserts Account credentials from Account.Credentials_vod |
All |
|
{{userEmailAddress}} |
Inserts the end user's email address from the Email field on the User object. This token is typically used in the from or reply-to fields of an outbound email template. |
All |
|
{{userName}} |
Inserts the end user’s name. |
All |
|
{{userPhoto}} |
Photo of user stored in the User_Detail_vod object. Photos display at their native size, except for in the My Profile tab, where it displays in 160x120 pixels. To preserve clarity, resize the photo to 160x120 pixels prior to uploading the photo. |
All |
|
{{parentCallDatetime}} |
Inserts the date and time of the associated Parent Call, ensuring this information is correct when the email is sent. This token does not include the timezone. Use the {{timeZone}} token to insert the timezone. When an email template has the token {{parentCallDatetime}}, it will be replaced by the:
|
|
|
{{parentCallDatetime(FORMAT)}} |
Creators can additionally specify the displayed format of the date or time. See Formatting Tokens to Display Date and Time for more information. |
|
|
{{timeZone}} |
For iPad end users, this token displays the value of the time zone of the device. The format is based on the user’s Salesforce locale. For Online end users, this token displays the value of the TimeZoneSidKey field on the User record and displays with the format: GMT +/- X hours. |
All |
|
Object Reference Tokens
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
Content creators can use this token to directly reference any field of a supported field type on the following objects:
The following field types are supported:
Examples:
|
All |
|
|
{{ObjectAPIName.FieldAPIName(FORMAT)}} |
If the referenced field is a Date or a Date/Time type field, creators can additionally specify the displayed format of the date or time. See Formatting Tokens to Display Date and Time for more information. |
All |
|
Enables referencing fields from lookup objects. See above for the list of supported objects and field types. This token is not supported for lookups on standard fields. Example: {{Call2_vod__c.Remote_Meeting_vod__r.Host_Link_vod__c}} |
All |
|
|
{{ObjectAPIName.RelationshipName.FieldAPIName(FORMAT)}} |
If the referenced field is a Date or a Date/Time type field, creators can additionally specify the displayed format of the date or time. See Formatting Tokens to Display Date and Time for more information. |
All |
|
{{Object1APIName.FieldAPIName;;Object2APNIName.FieldAPIName;;ObjectAPIName.FieldAPIName}} |
In Events Management, Speaker, content creators may use this token to reference fields from Speaker, Attendee and Team Member objects in an email template, as an attendee can fall under multiple different types. To avoid creating email templates for each attendee type, this token will choose the first field that returns the value for a given recipient. The order of preference is given to the field that is referenced first in the token. See Using Approved Email for Events Management for more information. Example: {{EM_Attendee_vod__c.Name;;EM_Event_Speaker_vod__c.Name;;EM_Event_Team_Member_vod.Name}} |
|
|
{{Object1APIName.FieldAPIName;;Object2APNIName.FieldAPIName(FORMAT)}} |
If the referenced field is a Date or a Date/Time type field, creators can additionally specify the displayed format of the date or time. See Formatting Tokens to Display Date and Time for more information. The field to format must be listed last in the list of tokens. |
|
|
{{customContent}} |
Inserts data from a defined custom query. See Inserting Queried Data into an Approved Email for more information. |
All |
|
{{Call2_vod__c.MS_Teams_Remote_Meeting_vod__r.MS_Teams_Meeting_Link_vod__c}} |
Enables users to share Microsoft Teams meeting links using Approved Email. |
All |
|
Sent Email Related tokens
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
{{EmailAddressUnsub}} |
Inserts the sent email address in a URL. The links are not available in Preview mode. This token can not be inserted in the body of the email. |
All |
|
{{EmailId}} |
Inserts the ID of the Sent_Email_vod record. This token is not supported in Edit and Preview mode. |
All |
|
{{OrgId}} |
Inserts the ID of the CRM environment from which the email was sent. |
All |
|
{{AppDocId}} |
To track email activity of which content is accessed most frequently, content creators may add this token to expand to the 18 digit Salesforce Id of the Approved Document record the token resides in. Example: <a href = "https://www.veeva.com/?{{AppDocId}}"> Click Here. </a> The expanded URL will be: https://www.veeva.com/?AppDocId=a1sJ0000003u458ADS See Tracking Email Activity at the Email Fragment Level for more information. |
n/a |
|
Functionality Tokens
Token |
Description |
Supported Entry Points | Works In |
---|---|---|---|
{{addToCalendar}} |
Inserts an .ICS attachment for recipients to add to their calendars. |
|
|
{{approvedEmailAction}} |
Creates a link in the email that, when selected, tracks as a standard click event. An email activity record is created in CRM, and a Multichannel Activity record is created with the appropriate record type. See Tracking Multichannel Activities from Approved Emails for more information. |
All |
|
{{EventSession}} |
Creates a table that lists out all of the sessions of a planned event. See Event Session and Event Speaker Tokens for more information Line breaks and spaces are not supported in this token. |
|
|
{{EventSpeaker}} |
Creates a table that lists out all of the speakers of a planned event. See Event Session and Event Speaker Tokens for more information Line breaks and spaces are not supported in this token. |
|
|
{{insertEngageAndZoomJoinURL[Language Code]}} |
Used to insert both Engage and Zoom URLs in invitations sent to attendees of an Engage meeting or of a virtual event. See Joining an Engage Meeting via Zoom and Joining a Virtual Event via Zoom for more information. This token is not supported for Event Speakers. |
|
|
{{insertZoomDialInNumbers[Language Code]}} |
Used to insert dial-in numbers in invitations sent to attendees of an Engage meeting or virtual event. See Adding Dial-in Numbers to Engage Invitations for more information. This token is not supported for Event Speakers. |
|
|
{{requiresReview}} | If this token is found in HTML of the Email Template or Template Fragment, the resulting Sent Email record will be created with Status_vod = Pending_vod | All |
|
{{schedulerLink}} |
Adds a link to the Engage Scheduling Site. See Sending Meeting Requests with Approved Email for more information |
All |
|
Vault Tokens
Token |
Description |
Supported Entry Points | Works In |
---|---|---|---|
{{$VaultDocID}} |
Expands to a URL pointing to a Vault PromoMats document with the corresponding VaultDocID. When using this token, replace VaultDocID with the ID of the appropriate document in Vault. The document ID is visible in the URL when viewing a Vault document. The integer to the right of #doc_info is always the unique Vault document ID. For example, {{$20}} points to Vault document ID 20. Example: https://customer.veevavault.com/ui/#doc_info/20/3/0 The document referenced by the token should be added to the Approved Document's Other Related Documents relationship in Vault. |
All |
|
Allows end users to send dynamic content to HCPs |
All |
|
|
{{ISILink}} |
Expands to a URL pointing to a Vault document of type Important Safety Information. |
All |
|
{{PieceLink}} |
Displays a URL to the Vault document associated as the Related Piece. |
All |
|
{{PILink}} |
Displays a URL to a Prescribing Information Vault document. |
All |
|
{{surveyLink}} |
Displays the associated survey. See Surveys in Approved Email for more information. |
All |
|
User Input Tokens
Text Tokens
All user input text is stamped on the User_Input_Text_vod field on the corresponding Sent_Email_vod record.
Zero-width non-joiner tokens (‌) should not be used in User Input Tokens (Text and Picklist Tokens).
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
{{customText}} |
Creates a blank text area in the email where the end user can enter free text. All entered text is evaluated against any defined restricted words or phrases. |
All except Receipts and Double Opt In |
|
{{customText(Length)}} |
Sets a maximum length for the entered free text. For example, {{customText(255)}} adds a text input area that can accept up to 255 characters. |
All except Receipts and Double Opt In |
|
{{customText(Length|DefaultText)}} |
Enables default text that displays when the text input area initially renders to the end user. The end user can then choose to replace the default text with their own. The DefaultText parameter can be used with the Length, or can be used independently using {{customText(|DefaultText)}}. Square brackets are not supported within default text for the custom free text token. |
All except Receipts and Double Opt In |
|
{{customText:Required}} |
Marks the free text field as required, ensuring end users do not exclude critical information in an email. This token is not supported on the Browser platform |
All except Receipts and Double Opt In |
|
{{customRichText}} |
Enables end users to add more versatile free text to an email through displaying a rich text area. Rich text enables end users to do the following:
The default size of the text area is 400 x 300 pixels. Do not enclose this token in <br> or <p> tags. It should only be enclosed by tags that are designed to have a closing tag, for example, <span> or <td> tags. This is because the rich text editor includes its own <p> tags, so enclosing the token in these tags causes styles to be lost. Images are not supported in the Rich Text editor. Entered text in a custom rich text field is checked against all defined Restricted Words and Phrases. |
All except Receipts and Double Opt In |
|
Picklist Tokens
Note the following when using picklist tokens:
- All configured picklist options are stamped on the Email_Config_Values_vod field of the corresponding Sent_Email_vod record.
- Zero-width non-joiner tokens (‌) should not be used in User Input Tokens (Text and Picklist Tokens).
- The first picklist value in Subject lines can be a NULL/blank value. This forces the user to select a subject before sending the email.
- Superscript tags are not supported in the subject line for an Approved Email template. However, content creators can add superscript to the subject line by cutting and pasting a character that is already in superscript into the Subject field in Vault.
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
{{customText[options]}} |
Adds a picklist field. All values are defined by the content creator, assuring that entries remain compliant while also granting a degree of personalization to the end user. Picklists can also be made with blank values by entering a picklist value of one space character. Do not use the |, ", or quot; characters in picklist values. The width of the picklist can be controlled by including CSS styling in the template's <style> tag for the CSS selector style.hideCustomTextValues. HTML tags inside this token are not supported. Example: {{customText[Hello|Dear|Hi]}} renders to the end user as a picklist with the following values:
The below two tokens will display blank value options in the picklist the end user sees:
Do not include line breaks or new lines in picklist values. |
All except Receipts and Double Opt In |
|
{{customText[##ContentToken1##|##ContentToken2##]}} |
Content Tokens can be used as values of this picklist by replacing the { and } characters of the content token with #. Do not use the |, ", or quot; characters in picklist values. Tokens from the following objects are supported:
Referenced fields display by their labels in the email rather than their values, though the values of these fields populate when the email is sent. HTML tags inside this token are not supported. Example: Sarah Jones composes an email to Dr. Clinton Ackerman with the following custom text token: {{customText[##accTitle## ##accFname## ##accLname##, ##accCredentials##|##accTitle## ##accLname##|##accFname##]}} In Edit mode, this token renders to Sarah as a picklist with the following options:
In Preview mode, this token renders to Sarah as the actual values of the selected option. Do not include line breaks or new lines in picklist values. |
All except Receipts and Double Opt In |
|
{{customText[##ContentToken1##|##ContentToken2(FORMAT)##]}} |
If the referenced field is a Date or a Date/Time type field, creators can additionally specify the displayed format of the date or time. See Formatting Tokens to Display Date and Time for more information. |
All except Receipts and Double Opt In |
|
Signature Transaction Receipt Tokens
See Creating Approved Email Receipt Content for more information.
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
{{insertCallSample[Column1,Column2]}} |
If call sample records exist, a table is rendered displaying all call samples associated with the call as rows. Columns can be defined as parameters of the token. For example: {{insertCallSample[Product_vod__r.Name,Quantity_vod__c]}} |
Receipts |
|
{{insertCallSample[Column1,Column2(FORMAT)]}} |
If the referenced field is a Date or a Date/Time type field, creators can additionally specify the displayed format of the date or time. See Formatting Tokens to Display Date and Time for more information. |
Receipts |
|
{{insertCallSample[filterProductType=TYPE,Column1,Column2]}}}} |
The filterProductType parameter on the {{insertCallSample}} filters all call samples on the call and only adds a row for each call sample of the specified product type. For example, the following renders two separate tables, one that only contains Samples, the other that only contains Educational Materials. Each table has different columns. {{insertCallSample[filterProductType=Sample,Quantity_vod__c,Product_vod__r.Name,Product_vod__r.Manufacturer_vod__c]}} </br> {{insertCallSample[filterProductType=Educational Material,Quantity_vod__c,Product_vod__r.Name]}} |
Receipts |
|
{{insertMedicalInquiry[Column1,Column2]}} |
If Medical Inquiries exist associated with the email, a table is rendered displaying all Medical Inquiries as rows. Columns can be defined as parameters of the token. For example: {{insertMedicalInquiry[Delivery_Method_vod__c,Product__c,Inquiry_Text__c]}} |
Receipts |
|
{{insertMedicalInquiry[Column1,Column2(FORMAT)]}} |
If the referenced field is a Date or a Date/Time type field, creators can additionally specify the displayed format of the date or time. See Formatting Tokens to Display Date and Time for more information. |
Receipts |
|
{{insertOrderLine}} |
If Order Lines exist associated with the email, a table is rendered displaying all Order Lines as rows. Columns can be defined as parameters of the token. For example: {{insertOrderLine[Quantity_vod__c,Product_vod__r.Name,Net_Price_vod__c,Total_Discount_vod__c]}} |
Receipts |
|
{{insertSignature}} |
Inserts a photo copy of the signature. |
Receipts |
|
Consent Capture Tokens
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
{{insertConsentLines}} |
Inserts the name of the products, content types, or sub-channels in the sent email. If an account selected Subscribe All, this message displays the channel label and the channel value. |
|
|
{{insertMCConsentLines[Subscribed,Unsubscribed]}} |
Inserts Multichannel_Consent_vod records into the Approved Email. The two parameters represent the label of the section headers.
If the parameters are blank, default labels are defined by the SUBSCRIBED;;ConsentCapture and UNSUBSCRIBED;;ConsentCapture Veeva Messages. This token is only supported in emails sent as receipts for Consent Capture. |
Consent Capture Receipts |
|
Unsubscribe Tokens
Unsubscribe Link Tokens
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
{{unsubscribe_product_link}} |
Inserts an unsubscribe link in an email. The unsubscribe link inherits the Product or Detail Group + Product associated with the template. When the recipient clicks the unsubscribe link, the opt-out activity is recorded for the Account, email address, and Product or Detail Group + Product in the corresponding Multichannel_Consent_vod record. All future emails to the Account plus the email address are suppressed for this Product or Detail Group + Product until an opt-in activity is collected or the opt-out expiration date is set. |
All except Receipts and Double Opt In |
|
{{unsubscribe_product_link[,Unsubscribe_vod.Unsubscribe_Identifier_vod]}} |
Allows content creators to customize the provided unsubscribe page to better control branding, translation, and wording. See Adding and Customizing Unsubscribe Links for more information. |
All except Receipts and Double Opt In |
|
{{unsubscribe_product_link[External URL,Unsubscribe_Identifier_vod]}} |
Embeds an unsubscribe link that directs users to an external hosted site defined by the External URL parameter. Used by the Embedded Unsubscribe feature. |
All except Receipts and Double Opt In |
|
Unsubscribe Page Tokens
Token |
Description |
Rendered Format |
Required? |
---|---|---|---|
{{EmailAddressUnsub}} |
Displays the email address associated with the unsubscribe request. |
Label | |
{{emailProduct}} |
Displays the Detail Product, Detail Group, or Content Type associated with the simple unsubscribe request. Although not required, it is recommended to include this token in unsubscribe pages to provide the end user information on what their simple unsubscribe request is for. |
Label |
|
{{submitUnsub}} |
Renders as an unsubscribe button that is used as the action of an HTML form data for a simple unsubscribe. The opt-out record created from the simple unsubscribe will be for the Product or Content Type of the Email Template where the unsubscribe link is clicked from. |
Button |
|
{{productModList}} |
Displays a selection menu with all Detail Products and Detail Groups with Approved Document records in Veeva CRM. Recipients can select which products or groups to unsubscribe from. If the customized Unsubscribe page is used, the Unsubscribe object has an HTML field where Admins can configure a custom Unsubscribe Page Related Unsubscribe Product records can be created to define the list of Product / Detail Groups displayed. Detail Products and Detail Groups restricted to the recipient do not display in this list. |
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. |
Check box |
|
Website Tokens
Token |
Description |
Supported Entry Points |
Works In |
---|---|---|---|
Tracks the following data about a web link shared with an HCP when appended to the link URL:
Example: https://www.verteobiopharma.com?{{linkTracker}} The tokens resolve to the following: https://verteobiopharma.com?src=VeevaCRM&dvc=iPad&sentDateTime=2021-08-25T20:05:28Z See Adding Tracking Tokens to Website URLs for more information about tracking websites. |
n/a |
|
|
Inserts the Mobile Id of the Sent_Message_vod record when the website is sent from the mobile device. |
n/a |
|