Merge Tags

Created by Agnivm Mukhopadhyay, Modified on Tue, 20 Jan at 12:40 PM by Rushikesh Pardeshi


What are merge tags?

Merge tags are dynamic variables that can be included in Email, SMS, or Push Notification Templates that help customize and/or personalize the content of messages.

Common Merge Tags with Explanations

Below is a list of merge tags that will work in SMS messages.


Merge Tag

What does this tag do?

Which Email and SMS Categories do these work in?

{{appointment.date}}

 

{{appointment.location}}

 

{{appointment.time}}

Returns the Appointment Date

 

Returns the Appointment Location

 

Returns the Appointment Time

  • Video Calling Invite

  • Appointment Reminder

  • Appointment Confirmation

  • Appointment Pending

  • Appointment Proposed
    New Time

  • Appointment Rescheduled

  • Appointment Declined

  • Appointment Cancelled

  • Survey

{{appointment.meetingLink}}

Provides a link to the virtual appointment room.

  • Video Calling Invite

  • Instant Meet Invite

  • Survey

{{appointment.declinedReason}}

Provides the reason an appointment was declined.

  • Appointment Declined

{{appointmentTimeText}}

Provides the time of an appointment.

  • Appointment Declined

  • Appointment Pending

  • Appointment Proposed
    New Time

{{article.title}}
{{article.description}}
{{article.name}}

READ ARTICLE with
HREF pointing to {{article.link}}

Returns the article title, article description and the article name.

  • Survey

  • Patient Educational Content

{{billingplan.name}}

Billing Plan Name

  • Billing Payment Failure

{{billingplan.amount}}

Billing Plan Amount

  • Billing Payment Failure

{{careplan.name}}

Returns the name of the Journey (aka Care Plan)

  • Care Plan Completion

  • Care Plan Progress Report to Patient

  • Care Plan Cancellation

  • Care Plan Payment Done

  • Care Plan Assignment

  • Single Care Plan Suggestion

  • Care Plan Onboarding

  • Survey

{{careplan.goal.daterange}}

Returns the date range of a Journey (aka Care Plan)

  • Care Plan Progress Report to Patient

{{careplan.goal.description}}

Returns the date range of a Journey (aka Care Plan)

  • Care Plan Progress Report to Patient

{% for form in formList %}
{{ form.link }}
{% endfor %}

Lists a hyperlink to each form in an SMS message using a URL shortener. 

  • Multiple Patient Forms

Can only be used in SMS Templates

{{employer.name}}

Returns the name of an employer.

  • Employer Invitation

{{employer.username}}

Provides a username login to the employer to access the Provider Web portal with very limited permissions.

  • Employer Invitation

{{employer.password}}

Provides a username login to the employer to access Provider Web portal with very limited permissions.

  • Employer Invitation

{% for form in formList %}

{{form.name}}

{% endfor %}

Returns the name of the form.

  • Multiple Patient Forms 

Can only be used in Email Templates

{{invoice.id}}
{{invoice.month}}{{invoice.amount}}
{{invoice.url}}

Includes a list of all invoices including the invoice ID, invoice amount and the invoice month.

Not in Use.

{{global.accountAdminUrl}}

Return the the Web URL to Administrator Login (Eg. YOURDOMAIN.foldhealth.io/#/admin)

ALL EMAIL AND SMS 
CATEGORIES

{{global.accountLogo}}

Returns the URL to the account logo that was uploaded. 

ALL EMAIL AND SMS 
CATEGORIES

{{global.accountName}}

Returns the name of the account or clinic, typically visible on the top left of the Fold Web App.

ALL EMAIL AND SMS 
CATEGORIES

{{global.clinicName}}

Returns the name of the clinic. Same as {{global.accountName}}

ALL EMAIL AND SMS 
CATEGORIES

{{general.text}}

Used in in the “General” email category.  This tag pulls in any text that is input at the Journey or Automation level.

  • User State Handling

  • CHW Engagement

  • General

  • Survey

{{global.accountName}}

Returns the name of the account or clinic, typically visible on the top left of the interface.

ALL EMAIL AND SMS 
CATEGORIES

{{global.accountPatientAppUrl}}

Provider the account URL for the patient web app.  Ex. yournamne.foldhealth.io

ALL EMAIL AND SMS 
CATEGORIES

{{groupname}}

Returns the name of a message group.

  • Conversation Engagement

 {{locationText}}

Sends the location for an appointment.

  • Appointment Pending

  • Appointment Proposed New Time

  • Appointment Declined

{{message.sender.name}} {{message.sender.sendTime}}
{{message.messageContent}}
{{message.attachmentUrl}}

Sends name of the person who sent the message, the time the message was sent, the content of the message  and if an attachment exists, pointing to the message URL.

TBD

{{messagingLink}} 

Link to a Chat Message

  • Chat Message Notification

{{patientapp.user}}
{{patientapp.password}}

Providers the patient’s username and new password for the patient account.

  • Survey

  • Mobile App Invitation

  • Account Invitation

  • Patient App Invitation

  • Patient Reset Password

As of Feb 2023, Username and Passwords have been deprecated in favor of {{secureLink}} invites.

{{patientAppStoreLink}}

{{patientPlayStoreLink}}

Returns the link to the Apple App Store Fold Care App and the Google Play Fold Care App.

ALL EMAIL AND SMS 
CATEGORIES

{{patient.firstName}}

Patient’s first name, example “Michael”

27 Categories, ALL except:

  • Overdue Invoices

  • Upcoming Invoices

  • Task Assigned

  • Billing Payment Failure

  • Instant Meet Invite

  • Membership OTP

  • User State Handling

  • User Reset Password

  • Employer Invitation

  • Meeting Invite

  • Campaign

  • CHW Engagement

  • Mobile App Invitation

  • Patient Educational Content

  • Account Invitation

  • General

  • Care Plan Progress Report to Supporting Member

  • Welcome Patient

  • Patient Invitation

{{proposedTimeText}}

Returns a proposed appointment time.

Appointment Proposed
New Time

{{provider.name}}

Returns the name of the provider.

  • Video Calling Invite

  • Conversation Engagement

  • Chat Message Notification

  • Appointment Reminder

  • Appointment Confirmation

  • Appointment Pending

  • Appointment Proposed New Time

  • Appointment Rescheduled

  • Appointment Declined

  • Appointment Cancelled

  • Survey

  • Instant Meet Invite

{{providerAppStoreLink}}

{{providerPlayStoreLink}}

Returns the link to the Apple App Store Fold Grow App and the Google Play Fold Grow App.

ALL EMAIL AND SMS 
CATEGORIES

 

 

ALL EMAIL AND SMS 
CATEGORIES

{{rsvpLink}}

Provides a link to accept or declined an appointment.

  • Appointment Pending

  • Appointment Proposed
    New Time

{{secureLink}}

Provides a one click login link to the patient app.

  • Reset Patient Password with SecureLink.

  • Patient App Invitation

{{secureLink}} is only generated in an Automation or via the password reset flow and does
not populate in a Campaign or when testing a template. 

{{subject.text}}

This tag will take the subject line from the Subject field you input, for example if you are using an automation and have the ability to edit the subject field for an email.

  • General 

{{to.name}}

{{from.name}

Specifies a recipient and a sender in an SMS node. 

  • Appointment Pending

  • Appointment Proposed New
    Time

  • Appointment Declined


Href is a field that controls where a hyperlink or a button will open into. The following merge tags return URLs that can be used in Href fields when creating email or SMS templates.


AREF

What does this tag do?

Where does this tag work?

{{appointment.bookingUrl}}

URL to book an appointment

  • Care Plan Onboarding

{{article.link}}

URL to an article

  • Survey

  • Patient Educational Content

{{form.link}}

URL to a form

  • Multiple Patient Forms

{{message.attachmentUrl}}

URL to a message attachement

TBD


For Loops and If Statement Examples

Fold allows you to compile multiple forms, messages and invoices in emails and SMS templates. Below are a few examples of these for Loops and If Statements.


Example

What does this do?

Where does this work?

{% for invoice in invoices %}

{{invoice.id }}
{{invoice.month}}
{{invoice.amount}}

{% endfor %}

Includes a list of all invoices including the invoice ID, invoice amount and the invoice month.

invoices are in beta 

Not currently
supported.

{% for message in messageList %}

{{message.sender.name}} {{message.sender.sendTime}}
{{message.messageContent}}

{%if message.attachmentUrl %}

CLICK HERE with HREF pointing to {{message.attachmentUrl}}

{% endif %}

 

{% endfor %}

A for loop with a nested if statement that a list of messages that the patient has not seen from a provider. Variables the name of the person who sent the message, the time the message was sent, the content of the message  and if an attachment exists, pointing to the message URL.

Not currently
supported.

{% for form in formList %}

{{form.name}}

{% endfor %}

Lists a name to each form in an email with href pointing to a URL of the form where href= {{form.link}}

Only works in Email 
templates.

{% for form in formList %}
{{ form.link }}
{% endfor %}

Lists a hyperlink to each form in an SMS message using a URL shortener. 

Only works in SMS 
templates.

{% if provider.name %} 

{{provider.name}} 

{% else %} 

{{global.accountName}} 

{% endif %}

Returns the provider name for the appointment and if there’s no provider name, will return the clinic name. 

For group appointments a random provider name will be return unless a “For every participant in appointment” filter is applied. 

Works only in the 
Appointments 
Automation
in all categories
(email and SMS).

 

List of all Merge Tags and Email and SMS Categories they work in.



Category

Supported Merge Tags (Email and SMS Template)

ALL CATEGORIES

 (List of all categories)

global.accountName
global.accountLogo
global.accountAdminUrl
global.accountPatientAppUrl
patientAppStoreLink
patientPlayStoreLink
providerAppStoreLink
providerPlayStoreLink

Care Plan Progress Report To Patient 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{careplan.goal.daterange}}
{{careplan.goal.description}}
{{careplan.name}} 

Care Plan Cancellation 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{careplan.name}}
{{careplan.discountinuedate}} 

Patient Form 

Patient Form has been deprecated. Do not use this Category.

{{form.link}}
{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}} 

Multiple Patient Forms 

{{form.link}}
{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{formList.0.link}}
{{formList.0.name}}
{{formList.1.link}}
{{formList.1.name}}
{{formList.2.link}}
{{formList.2.name}}
{{formList.3.link}}
{{formList.3.name}} 

Patient App Invitation 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{patientapp.user}}
{{patientapp.password}} 

Care Plan Payment Done 

{{lead.firstName}}
{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{careplan.name}} 

Care Plan Assignment 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{careplan.name}} 

Single Care Plan Suggestion 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{careplan.link}}
{{careplan.name1}}
{{careplan.price1}}
{{careplan.description1}} 

Membership Invoice 

{{order.id}}
{{order.name}}
{{order.price}}
{{order.description}}
{{invoice.number}}
{{invoice.dateDue}}
{{invoice.dateOfIssue}}
{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{payment.0.time}}
{{payment.0.amount}}
{{payment.0.number}}
{{payment.0.paymentType.id}}
{{payment.0.paymentType.name}}
{{payment.0.paymentState}}
{{payment.0.transactionId}}
{{payment.1.time}}
{{payment.1.amount}}
{{payment.1.number}}
{{payment.1.paymentType.id}}
{{payment.1.paymentType.name}}
{{payment.1.paymentState}}
{{payment.1.transactionId}}
{{customer.city}}
{{customer.phone}}
{{customer.state}}
{{customer.company}}
{{customer.country}}
{{customer.zipCode}}
{{customer.address1}}
{{customer.address2}}
|{{customer.lastName}}
{{customer.firstName}}
{{itemDetails.0.name}}
{{itemDetails.0.image}}
{{itemDetails.0.price}}
{{itemDetails.0.quantity}}
{{itemDetails.0.totalPrice}}
{{itemDetails.1.name}}
{{itemDetails.1.image}}
{{itemDetails.1.price}}
{{itemDetails.1.quantity}}
{{itemDetails.1.totalPrice}} 

Video Calling Invite 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{provider.name}}
{{provider.credentials}}
{{appointment.date}}
{{appointment.time}}
{{appointment.reason}}
{{appointment.location}}
{{appointment.meetingLink}} 

Conversation Engagement 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{provider.name}}
{{provider.credentials}}
{{groupName}}
{{messageList.0.sender.name}}
{{messageList.0.sender.sendTime}}
{{messageList.0.messageContent}}
{{messageList.1.sender.name}}
{{messageList.1.sender.sendTime}}
{{messageList.1.attachmentUrl}}
{{conversationUrl}} 

Care Plan Onboarding 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{careplan.name}}
{{appointment.bookingUrl}} 

Patient Reset Password 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
|{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{patientapp.user}}
{{patientapp.password}} 

Chat Message Notification 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{provider.name}}
{{provider.credentials}}
{{messagingLink}} 

Appointment Reminder 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{provider.name}}
{{provider.credentials}}
{{appointment.date}}
{{appointment.time}}
{{appointment.reason}}
{{appointment.location}} 

Appointment Confirmation 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{provider.name}}
{{appointment.date}}
{{appointment.time}}
{{appointment.reason}}
{{appointment.location}} 

Care Plan Suggestion 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{carePlans.0.title}}
{{carePlans.0.duration}}
{{carePlans.0.description}}
{{carePlans.1.title}}
{{carePlans.1.duration}}
{{carePlans.1.description}}
{{carePlans.2.title}}
{{carePlans.2.duration}}
{{carePlans.2.description}} 

Appointment Pending 

{{to.name}}
{{from.name}}
{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{provider.name}}
{{rsvpLink}}
{{appointment.date}}
{{appointment.time}}
{{appointment.reason}}
{{appointment.location}}
{{locationText}}
{{appointmentTimeText}} 

Appointment Proposed New Time 

{{to.name}}
{{from.name}}
{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{provider.name}}
{{rsvpLink}}
{{appointment.date}}
{{appointment.time}}
{{appointment.reason}}
{{appointment.location}}
{{locationText}}
{{proposedTimeText}}
{{appointmentTimeText}} 

Appointment Rescheduled 

{{patient.email}}
{{patient.gender}}
{{patient.zipCode}}
{{patient.lastName}}
{{patient.firstName}}
{{patient.dateOfBirth}}
{{patient.phoneNumber}}
{{provider.name}}
{{appointment.date}}
{{appointment.time}}
{{appointment.reason}}
{{appointment.location}} 

Overdue Invoices 

{{invoices.0.id}}
{{invoices.0.link}}
{{invoices.0.month}}
{{invoices.0.amount}}
{{invoices.1.id}}
{{invoices.1.link}}
{{invoices.1.month}}
{{invoices.1.amount}} 

Upcoming Invoices 

{{invoice.month}}
{{invoice.amount}} 

Task Assigned 

{{task.title}}
{{task.status}}
{{task.dueDate}}
{{task.priority}}
{{task.description}} 

Billing Payment Failure 

{{billingPlan.name}}
{{billingPlan.amount}} 

Appointment Declined 

{{to.name}}
{{from.name}}
{{patient.name}}
{{patient.lastName}}
{{patient.firstName}}
{{provider.name}}
{{appointment.date}}
{{appointment.time}}
{{appointment.reason}}
{{appointment.location}}
{{appointment.declinedReason}}
{{locationText}}
{{appointmentTimeText}} 

Appointment Cancelled 

{{patient.name}}
{{patient.lastName}}
{{patient.firstName}}
{{provider.name}}
{{appointment.date}}
{{appointment.time}}
{{appointment.reason}}
{{appointment.location}} 

Survey 

{{form.link}}
{{task.name}}
{{task.description}}
{{admin.user}}
{{admin.password}}
{{article.link}}
{{article.name}}
{{article.title}}
{{article.description}}
{{general.text}}
{{patient.lastName}}
{{patient.diagnosis}}
{{patient.firstName}}
{{careplan.name1}}
{{careplan.name2}}
{{careplan.name3}}
{{careplan.price1}}
{{careplan.price2}}
{{careplan.price3}}
{{careplan.description1}}
{{careplan.description2}}
{{careplan.description3}}
{{formList.0.link}}
{{formList.0.name}}
{{formList.1.link}}
{{formList.1.name}}
{{formList.2.link}}
{{formList.2.name}}
{{formList.3.link}}
{{formList.3.name}}
{{provider.name}}
{{provider.credentials}}
{{patientapp.user}}
{{patientapp.password}}
{{appointment.date}}
{{appointment.time}}
{{appointment.location}}
{{appointment.meetingLink}} 

Instant meet invite 

{{provider.name}}
{{provider.credentials}}
{{appointment.meetingLink}} 

Membership OTP 

{{otp}} 

User State Handling 

{{general.text}} 

User Reset Password 

{{user.link}}
{{user.password}}
{{user.username}}
{{user.firstName}} 

Employer Invitation 

{{employer.name}}
{{employer.password}}
{{employer.username}} 

Appointment Booking Link 

{{patient.lastName}}
{{patient.firstName}}
{{appointment.link}} 

Meeting Invite 

  No tags 

Campaign 

  No tags 

CHW Engagement 

{{general.text}} 

Mobile App Invitation 

{{admin.user}}
{{admin.password}}
{{patientapp.user}}
{{patientapp.password}} 

Tasks Reminder 

{{task.name}}
{{task.description}}
{{patient.firstName}} 

Patient Educational Content 

{{article.link}}
{{article.name}}
{{article.title}}
{{article.description}} 

Account Invitation 

{{admin.user}}
{{admin.password}}
{{patientapp.user}}
{{patientapp.password}} 

Care Plan Goal Completion 

{{patient.firstName}} 

Care Plan Completion 

{{patient.firstName}}
{{careplan.name}} 

General 

{{general.text}} will replace the body if the email.
{{subject.text}} will replace the subject line of the email.

Care Plan Progress Report To Supporting Member 

 No merge tags supported.

Welcome Patient 

 No merge tags supported.

Patient Invitation 

 No merge tags supported.




Reference : Confluence

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article