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 |
|
{{appointment.meetingLink}} | Provides a link to the virtual appointment room. |
|
{{appointment.declinedReason}} | Provides the reason an appointment was declined. |
|
{{appointmentTimeText}} | Provides the time of an appointment. |
|
{{article.title}} READ ARTICLE with | Returns the article title, article description and the article name. |
|
{{billingplan.name}} | Billing Plan Name |
|
{{billingplan.amount}} | Billing Plan Amount |
|
{{careplan.name}} | Returns the name of the Journey (aka Care Plan) |
|
{{careplan.goal.daterange}} | Returns the date range of a Journey (aka Care Plan) |
|
{{careplan.goal.description}} | Returns the date range of a Journey (aka Care Plan) |
|
{% for form in formList %} | Lists a hyperlink to each form in an SMS message using a URL shortener. |
Can only be used in SMS Templates |
{{employer.name}} | Returns the name of an employer. |
|
{{employer.username}} | Provides a username login to the employer to access the Provider Web portal with very limited permissions. |
|
{{employer.password}} | Provides a username login to the employer to access Provider Web portal with very limited permissions. |
|
{% for form in formList %} {{form.name}} {% endfor %} | Returns the name of the form. |
Can only be used in Email Templates |
{{invoice.id}} | 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 |
{{global.accountLogo}} | Returns the URL to the account logo that was uploaded. | ALL EMAIL AND SMS |
{{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 |
{{global.clinicName}} | Returns the name of the clinic. Same as {{global.accountName}} | ALL EMAIL AND SMS |
{{general.text}} | Used in in the “General” email category. This tag pulls in any text that is input at the Journey or Automation level. |
|
{{global.accountName}} | Returns the name of the account or clinic, typically visible on the top left of the interface. | ALL EMAIL AND SMS |
{{global.accountPatientAppUrl}} | Provider the account URL for the patient web app. Ex. yournamne.foldhealth.io | ALL EMAIL AND SMS |
{{groupname}} | Returns the name of a message group. |
|
{{locationText}} | Sends the location for an appointment. |
|
{{message.sender.name}} {{message.sender.sendTime}} | 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 |
|
{{patientapp.user}} | Providers the patient’s username and new password for the patient account. |
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 |
{{patient.firstName}} | Patient’s first name, example “Michael” | 27 Categories, ALL except:
|
{{proposedTimeText}} | Returns a proposed appointment time. | Appointment Proposed |
{{provider.name}} | Returns the name of the provider. |
|
{{providerAppStoreLink}} {{providerPlayStoreLink}} | Returns the link to the Apple App Store Fold Grow App and the Google Play Fold Grow App. | ALL EMAIL AND SMS |
|
| ALL EMAIL AND SMS |
{{rsvpLink}} | Provides a link to accept or declined an appointment. |
|
{{secureLink}} | Provides a one click login link to the patient app. |
{{secureLink}} is only generated in an Automation or via the password reset flow and does |
{{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. |
|
{{to.name}} | Specifies a recipient and a sender in an SMS node. |
|
Href Links
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 |
|
{{article.link}} | URL to an article |
|
{{form.link}} | URL to a form |
|
{{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 }} {% endfor %} | Includes a list of all invoices including the invoice ID, invoice amount and the invoice month.
| Not currently |
{% for message in messageList %} {{message.sender.name}} {{message.sender.sendTime}} {%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 |
{% 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 |
{% for form in formList %} | Lists a hyperlink to each form in an SMS message using a URL shortener. | Only works in SMS |
{% 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 |
List of all Merge Tags and Email and SMS Categories they work in.
Category | Supported Merge Tags (Email and SMS Template) |
|---|---|
ALL CATEGORIES | global.accountName |
Care Plan Progress Report To Patient | {{patient.email}} |
Care Plan Cancellation | {{patient.email}} |
Patient Form Patient Form has been deprecated. Do not use this Category. | {{form.link}} |
Multiple Patient Forms | {{form.link}} |
Patient App Invitation | {{patient.email}} |
Care Plan Payment Done | {{lead.firstName}} |
Care Plan Assignment | {{patient.email}} |
Single Care Plan Suggestion | {{patient.email}} |
Membership Invoice | {{order.id}} |
Video Calling Invite | {{patient.email}} |
Conversation Engagement | {{patient.email}} |
Care Plan Onboarding | {{patient.email}} |
Patient Reset Password | {{patient.email}} |
Chat Message Notification | {{patient.email}} |
Appointment Reminder | {{patient.email}} |
Appointment Confirmation | {{patient.email}} |
Care Plan Suggestion | {{patient.email}} |
Appointment Pending | {{to.name}} |
Appointment Proposed New Time | {{to.name}} |
Appointment Rescheduled | {{patient.email}} |
Overdue Invoices | {{invoices.0.id}} |
Upcoming Invoices | {{invoice.month}} |
Task Assigned | {{task.title}} |
Billing Payment Failure | {{billingPlan.name}} |
Appointment Declined | {{to.name}} |
Appointment Cancelled | {{patient.name}} |
Survey | {{form.link}} |
Instant meet invite | {{provider.name}} |
Membership OTP | {{otp}} |
User State Handling | {{general.text}} |
User Reset Password | {{user.link}} |
Employer Invitation | {{employer.name}} |
Appointment Booking Link | {{patient.lastName}} |
Meeting Invite | No tags |
Campaign | No tags |
CHW Engagement | {{general.text}} |
Mobile App Invitation | {{admin.user}} |
Tasks Reminder | {{task.name}} |
Patient Educational Content | {{article.link}} |
Account Invitation | {{admin.user}} |
Care Plan Goal Completion | {{patient.firstName}} |
Care Plan Completion | {{patient.firstName}} |
General | {{general.text}} will replace the body if 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
Feedback sent
We appreciate your effort and will try to fix the article