View desktop instructions

View mobile app instructions
Merge Tags for Program Emails

Published on: Fri, 7 Jul, 2023 at 3:42 AM | Updated on: Wed, 7 Aug, 2024 at 6:25 AM

Merge tags allow Advocate to populate your program’s transactional emails with dynamic information about:

Participant information

Merge tag	Description	Example
`{{user.firstName}}`	The first name of the participant viewing the email.	`{{user.firstName}}` `{{user.lastName}}`, you’ve earned a reward!
`{{user.lastName}}`	The last name of the participant viewing the email.	`{{user.firstName}}` `{{user.lastName}}`, you’ve earned a reward!
`{{user.referralCode}}`	The participant's referral code.	Your personal referral code is `{{user.referralCode}}`.
`{{user.customFields.xxx}}`	Use this tag to reference any participant information that you’ve included as a custom field. This example shows a merge that populates with the name of the company for which the participant works.	Share your referral information with your colleagues at `{{user.customFields.companyName}}`.

Reward details

Merge tag	Description	Example
`{{reward.prettyValue}}`	The value of the reward in a formatted manner (e.g., $15.00).	Get `{{reward.prettyValue}}` off your next order.
`{{reward.unit}}`	The unit of the reward (e.g., Point or Month).	You’ve received a `{{reward.unit}}` for referring your friend, `{{referral.referredUser.firstName}}`!
`{{reward.name}}`	The name of the reward as seen in the Reward Catalog.	Congratulations on your reward of `{{reward.name}}`!
`{{formatDate reward.dateGiven "dd/MM/yyyy"}}`	The date that the reward was fulfilled. The date format is adjustable.	You earned a `{{reward.name}}` on `{{formatDate reward.dateGiven "dd/MM/yyyy"}}`. Make sure to redeem it before it expires on `{{formatDate reward.dateExpires "dd/MM/yyyy"}}`!
`{{formatDate reward.dateExpires "dd/MM/yyyy"}}`	The date that the reward will expire, if an expiry has been set in your program rules. The date format is adjustable.	You earned a `{{reward.name}}` on `{{formatDate reward.dateGiven "dd/MM/yyyy"}}`. Make sure to redeem it before it expires on `{{formatDate reward.dateExpires "dd/MM/yyyy"}}`!
`{{reward.fuelTankCode}}`	The fuel tank reward code, if you are using this feature.	Use code `{{reward.fuelTankCode}}` to apply your discount to your next purchase.

Referral-specific information

Merge tag	Description	Example
`{{referral.referrerUser.firstName}}`	The first name of the customer advocate who made the referral.	`{{referral.referrerUser.firstName}}` `{{referral.referrerUser.lastName}}`, your friend `{{referral.referredUser.firstName}}{{referral.referredUser.lastName}}` has signed up!
`{{referral.referrerUser.lastName}}`	The last name of the customer advocate who made the referral.	`{{referral.referrerUser.firstName}}` `{{referral.referrerUser.lastName}}`, your friend `{{referral.referredUser.firstName}}{{referral.referredUser.lastName}}` has signed up!
`{{referral.referredUser.firstName}}`	The first name of the referred friend.	`{{referral.referrerUser.firstName}}` `{{referral.referrerUser.lastName}}`, your friend `{{referral.referredUser.firstName}}{{referral.referredUser.lastName}}` has signed up!
`{{referral.referredUser.lastName}}`	The last name of the referred friend.	`{{referral.referrerUser.firstName}}` `{{referral.referrerUser.lastName}}`, your friend `{{referral.referredUser.firstName}}{{referral.referredUser.lastName}}` has signed up!

Share & message links

Merge tag	Description	Example
`{{user.email}}`	Generates the message link that is sent out in referral emails.	Share via `{{user.email}}`.
`{{user.shareLink}}`	The participant’s main share link. This shows up as `UNKNOWN` in Analytic reports. This link is meant for the participant to copy and provide to other people, rather than to click on themselves.	Provide this share link to your friends: `{{user.shareLink}}`
`{{user.facebook}}`	The participant's message link for Facebook.	Share on `{{user.facebook}}`.
`{{user.fbmessenger}}`	The participant's message link for Facebook Messenger.	Share on `{{user.fbmessenger}}`.
`{{user.twitter}}`	The participant's message link for X (twitter).	Share on `{{user.twitter}}`.
`{{user.linkedin}}`	The participant's message link for LinkedIn.	Share on `{{user.linkedin}}`.
`{{user.sms}}`	The participant's message link for texting.	Share via `{{user.sms}}`.