Using Email Templates
Email templates are the pre-defined email messages used by the Platform. The language and content can be customized for each message, or you may use the default text.
This article covers:
- Editing a message template
- Enabling a message template
- Email template definitions
- Customizing a message template
- Display Variables
Editing a Message Template
You can edit the text of a template, including adding HTML or Markdown language.
Notes
- Email templates are zone-specific. Ensure that you have the correct zone selected in Settings -> Zone Settings -> Current Zone before you make any changes to a template.
- Email templates are written using HTML and Markdown. You will see this formatting, but your users will not.
- Select the template you want to edit.
- Edit the Subject line, if desired.
Click in the the main text area.
Make the desired text changes. View the list below of display variables you can use in a message.
Click the Save button.
Select any additional zones you where you want to apply your changes.
- Click Confirm.
Enabling a Message Template
A message template Enabled to be sent by the Platform.
Enable or disable each message individually by using the toggle next to the message.
Click Save after making any changes.
Enable or disable all message by using the toggle or links next to Enable Email Notifications.
Click Save after making any changes.
Email Template Definitions
| Template Name | Definition |
| Deep Link (Welcome Message) | Sent when the user joins the platform as an active user. |
| Reactivated Message (Welcome Back) | Sent when a user has been reactivated. This message contains the user's Deep Link. |
| Session Reminder | The reminder that’s sent based on the health survey. |
| Consecutive Reminder | A reminder to users to fulfill their daily session of the Daily Pulse Survey or Health Survey. |
| BluePass | The message the end user sees when they receive their BluePass. |
| GreenPass | The message the end user sees when they receive their GreenPass. |
| GreenPass Expiry Reminder | The message the end user sees to let them know when their GreenPass will expire. The message will be sent based on the value in the Remind before Days field. The message will be sent at user's remindMeAt time. |
| BluePass Expiry Reminder | The message the end user sees to let them know when their BluePass will expire. The message will be sent based on the value in the Remind before Days field. The message will be sent at user's remindMeAt time. |
| Forced Isolation | Displays when Forced Isolation has been applied to a user. |
| Appointment Confirmation | Displays when the end user schedules a test. |
| Scheduled Test Reminder | Displays when a user has scheduled their test. |
| Medical Test: Positive | Displays when a user’s test kit tests positive. |
| Medical Test: Pending Positive | Displays when a user’s test kit tests positive. |
| Medical Test: Negative | Displays when a user’s test kit tests negative. |
| Medical Test: Inconclusive | Displays when a user's test kit results are inconclusive. |
| Medical Test: Invalid | Displays when a user's test kit results does not produce a valid result. |
| Medical Test: Rejected (Default & Reason 1-4) |
Displays when a user’s test kit results have been rejected by an Admin. You have the option of having up to 5 separate reasons for rejecting a medical test. Use the default Name and Content text or customize each template for your organization. Changing the text of Name line of these templates will change the drop-down selection menu in the Reject Reason window. Notes: -- While the Name of each of the Default and Reasons 1-4 templates display in the drop-down menu on the user profile, you must enable each template for the email to be sent to the user. -- The Name field on the SMS and Email templates automatically sync. When you make a change to the field on one type of template the Name field on the other type of template will automatically update. -- After a test has been rejected, a note is automatically generated in the user's profile explaining the rejection reason with the use of the Name section from the respective template. Tags can also be automatically assigned to a user after a test rejection. They can be defined by selecting the template of choice and scrolling to the bottom of the page to the Tags field. Click the Save button at the top of the page after making any changes. |
| Vaccination: Rejected | Displays when a user's vaccination information has been reviewed by an Admin and been rejected. |
| Contact Tracing: Exposure | Message that’s sent via the Contact Tracing tool when exposure is suspected. |
| Temperature Scan: Success | Displays when the end user successfully enters their temperature on their profile. This message is also used when the end user checks in through a CS Auto or CSTS Auto device. Note: The Show Upload Daily Temperature Reading button in Settings-User Experience must be enabled for this feature to display to the end user. |
| Temperature Scan: Fail | Displays when the end user tries to enter their temperature on their profile, but is unsuccessful. This message is also used when the end user checks in through a CS Auto or CSTS Auto device. Note: The Show Upload Daily Temperature Reading button in Settings-User Experience must be enabled for this feature to display to the end user. |
| Temperature Scan: Repeat Fail | Displays when the end user makes multiple attempts to enter their temperature on their profile but is unsuccessful. This message is also used when the end user checks in through a CS Auto or CSTS Auto device. Note: The Show Upload Daily Temperature Reading button in Settings-User Experience must be enabled for this feature to display to the end user. |
| Temperature Scan: No HealthPass | Displays when the end user tries to enter their temperature on their profile but does not have a HealthPass. This message is also used when the end user checks in through a CS Auto or CSTS Auto device. Note: The Show Upload Daily Temperature Reading button in Settings-User Experience must be enabled for this feature to display to the end user. |
| Check-in: Success | Displays when the end user checks in successfully through a CS Auto or CSTS Auto device. |
| Check-in: Repeat success | Displays when the end user checks in successfully through a CS Auto or CSTS Auto device, then checks in again. |
| Check-in: No HealthPass | Displays when the end user tries to check in successfully through a CS Auto or CSTS Auto device but does not have a HealthPass. Note: This does not mean the user is symptomatic. |
| Check-in: Covid-19 Test Needed | Displays when the user tries to check in, but has broken either a survey rule or a test rule. |
| Check-out: Success | Displays when the user tries to check out, but has broken either a survey rule or a test rule. |
| One-time Password | Displays when a user clicks the Forgot Password link. Note: This template must be enabled for a user to view test results as the One-time Password is required for Multi-Factor Authentication. |
| Custom Template 1-5 | Displays when an Admin sends a message to one or more user from the Users dashboard via the Message -> Custom Template drop-down menu. Note: While the each of the Custom Templates displays in the drop-down menu on the Message -> Custom Template tab on the Users page, you must enable each template you want to use in Settings -> Email Templates for the email to be sent to the user. |
Customing Message Templates
You can further customize an email template by using one or more of the display variables listed in the table below.
When you use a display variable, the information listed in the Function column will automatically display to the end user. For example, in the following example "<[user_name]>" and "<[location_name]>" will be replaced with the name of the user the message is sent to, and the location.
Example
Hello <[user_name]>,
Please have your paperwork turned in by Friday to <[location_name]>.
Thank you