Merge Keys allow you to templatize your communications by merging in applicant- or opening-specific information when sending out. Most applicant and Opening information can be used as a Merge Key in SMS messages and emails; for example, if you used the Merge Key [FIRST_NAME] in an email, it'll populate the name "John" when sending the email to John. You can readily access and utilize them in any Message Template.

Insert Merge Keys

Click your initials and then click Company Settings in the dropdown.
Under App Settings in the left side panel, click Message Templates.
Search for the template you want to edit in the search bar, and click Actions then Edit Template from the dropdown menu.

To create a new template, select Add Template. Visit this article for additional instructions on creating new message templates.
Click Edit Email when the message template appears.
Select the Merge Key Group that contains the Merge Key you want to add to your message template located under the Insert Merge Keys section. A dropdown menu containing different Merge Keys you can input will appear.
Choose the Merge Key you want to add to your email and click in the area of the email you want to insert this Merge Key.

We will select the merge key Applicant Full Name.
The Merge Key you just selected will appear in the email message template. Click Save Message.

Important Note

If you include "_LINK" ([PORTAL_LINK] or [BOOKED_SLOT_RESCHEDULE_LINK] for example) in a message template that uses HTML code, you must wrap the Merge Keys in anchor tags (example: <a href="[MY_MERGE_KEY_LINK]">Go here</a>). If you do not wrap the Merge Keys in anchor tags, Previewing from the applicant's perspective will not display the links in the message correctly and you will not see the message in the same way that the applicant will see it.

Merge Key Groups

We support the following groups of Merge Keys: Opening Keys, Custom Keys, and Stage Keys. Stage message templates sometimes contain a list of required keys, which you'll need to include in your stage message before you can save it. The list of keys will show under Insert Merge Keys on the left tab.

Opening Keys

(Can be used while the applicant is in any stage.)

Merge Key	Merge Key Description
[ACCOUNT_NAME]	Account Name
[BRAND_NAME]	Brand Name
[STAGE_TITLE]	Stage Title (Internal stage title)
[STAGE_PORTAL_TITLE]	External Facing Applicant Portal Title Of The Stage
[OPENING_NAME]	Opening Name
[OPENING_ID]	Opening Identifier
[OPENING_OWNER_EMAIL]	Opening Owner Email
[OPENING_OWNER_FIRST_NAME]	Opening Owner First Name
[OPENING_ADDRESS]	Opening Address
[OPENING_INFO]	Opening Additional Info
[OPENING_PAY_RATE]	Opening Pay Rate
[OPENING_EMPLOYMENT_TYPE]	Opening Employment Type
[SELECTED_SHIFT]	Shift Type
[SENDER_SIGNATURE]	Sender Signature
[SENDER_NAME]	Sender Name
[SENDER_EMAIL]	Sender Email
[SENDER_FIRST_NAME]	Sender First Name
[SENDER_PHONE_NUMBER]	Sender Phone Number
[PORTAL_LINK]	Portal Link (will provide a link that says Applicant Portal that can be clicked by the applicant. This Merge Key can only be used in email. It will not format to say Applicant Portal if sent via SMS)
[PORTAL_URL]	Portal URL (will send a long-form hyperlink in both email or SMS that can be clicked by the applicant)
[TIME_ZONE]	Position Time Zone

Applicant Keys

(Can be used while the applicant is in any stage.)

Merge Key	Merge Key Description
[APPLICANT_NAME]	Applicant Full Name
[APPLICANT_EMAIL]	Applicant Email
[APPLICANT_FIRST_NAME]	Applicant First Name
[APPLICANT_LAST_NAME]	Applicant Last Name
[APPLICANT_PHONE_NUMBER]	Applicant Phone Number
[APPLICANT_IDLE_SINCE]	Applicant Last Activity Date and Time
[APPLICANT_DATE_APPLIED]	Applicant Date Applied
[APPLICANT_DAYS_SINCE_APPLYING]	Applicant Days Since Applying
[APPLICANT_KEY]	Applicant Key
[APPLICANT_ID]	Applicant ID

Action Keys

(Can only be used in a custom stage or video recording stage in the Customize Portal Body.)

Merge Key	Merge Key Description
[ADVANCE_URL]	Advances applicant to the next stage.

Scheduler Keys

(Can only be used if the applicant is in the Scheduler stage.)

Merge Key	Merge Key Description
[AVAILABLE_SLOTS]	Available Slots for Current Stage
[AVAILABLE_SLOTS_WITH_LOCATION]	Available Slots with Location for Current Stage
[AVAILABLE_SLOTS_LINK]	Available Slots Link (only used as a standalone link)
[AVAILABLE_SLOTS_URL]	Available Slots URL (can be used to create a custom link)

Data Collection Keys

(Can only be used if the applicant is in the Data Collection stage and in the initial stage message, any follow-up messages should use [PORTAL_LINK] or [PORTAL_URL]).

Merge Key	Merge Key Description
[DOCUMENT_UPLOAD_LINK]	Document Upload Form Link (EMAIL ONLY, only used as a standalone link)
[DATA_COLLECTION_FORM_LINK]	Data Collection Form Link (EMAIL & SMS, only used as a standalone link)
[DATA_COLLECTION_FORM_URL]	Data Collection Form URL (EMAIL & SMS, can be used to create a custom link)

File Recollection Keys

(Can only be used if the applicant has a file in recollection.)

Merge Key	Merge Key Description
[PORTAL_UPLOAD_REQUEST_LINK]	File recollection (EMAIL & SMS, only used as a standalone link)
[PORTAL_UPLOAD_REQUEST_URL]	File recollection (EMAIL ONLY, can be used to create a custom link)

Consent Keys

(Can only be used if the applicant has an open background check request.)

Merge Key	Merge Key Description
[BGC_CONSENT_LINK]	Background Check Consent Link (only used as a standalone link)
[BGC_CONSENT_URL]	Background Check Consent URL (can be used to create a custom link)

Reminder Keys

(Can only be used if the applicant is in the Scheduler stage.)

Merge Key	Merge Key Description
[BOOKED_SLOT_START]	Session Start Date and Time
[BOOKED_SLOT_END]	Session End Date and Time
[BOOKED_SLOT_START_TIME]	Session Start Time
[BOOKED_SLOT_END_TIME]	Session End Time
[BOOKED_SLOT_DATE]	Session Start Date
[BOOKED_SLOT_PERIOD]	Session Start and End Date and Time
[BOOKED_SLOT_TIME_RANGE]	Session Start and End Times
[SESSION_INSTRUCTIONS]	Instructions. Only works with confirmation emails and not for initial stage emails.
[BOOKED_SLOT_CANCEL_LINK]	Link to Cancel Slot (only be used as a standalone link)
[BOOKED_SLOT_CANCEL_URL]	URL to Cancel Slot (can be used to create a custom link)
[BOOKED_SLOT_RESCHEDULE_LINK]	Link to Reschedule Slot (only be used as a standalone link)
[BOOKED_SLOT_RESCHEDULE_URL]	URL to Reschedule Slot (can be used to create a custom link)
[BOOKED_SLOT_USER_EMAIL]	Slot Assigned User Email
[BOOKED_SLOT_USER_NAME]	Slot Assigned User Name
[BOOKED_SLOT_USER_PHONE_NUMBER]	Slot Assigned User Phone Number
[SMS_RSVP_YES]	SMS Command to Confirm Session (reply must be received within 3 hrs)
[SMS_RSVP_NO]	SMS Command to Cancel Session (reply must be received within 3 hrs)
[ONSITE_ADDRESS]	On-Site Address

Important Note

If an applicant has a scheduled session and sends an SMS with the word "No" after a Reminder Message is sent out, the system will cancel their session even if the [SMS_RSVP_YES] or [SMS_RSVP_NO] Merge Keys are not in use.

Document Signing Keys

(Only available for our in-app integration. Can only be used if the applicant is in the Document Signing stage and in the initial stage message, any follow-up messages should use [PORTAL_LINK] or [PORTAL_URL]).

Merge Key	Merge Key Description
[DOCUMENT_SIGNING_LINK]	Document signing link for our in-app integration (can only be used as a standalone link)

Learning Stage Keys

(Lessonly & Northpass can only be used if the applicant is in a learning stage and in the initial stage message, any follow-up messages should use [PORTAL_LINK] or [PORTAL_URL]).

Merge Key	Merge Key Description
[LESSONLY_LINK]	Lessonly Link (only be used as a standalone link)
[LESSONLY_RESOURCE]	Lessonly Resource Name (Course or Lesson)
[LESSONLY_URL]	Lessonly Url (can be used to create a custom link)
[SCHOOLKEEP_LINK]	SchoolKeep Link (only be used as a standalone link)
[SCHOOLKEEP_URL]	SchoolKeep Url (can be used to create a custom link)

Custom Keys

This list of these keys are dynamic and contains keys for all Applicant Data fields in the account. The general format for these will include the name or type of data key separated by underscores. Please note, the Custom Key must always start with APPLICANT_DATA. Example: [APPLICANT_DATA_KEY].

Applicant Address Keys

These are based on the Fountain customer's address field key names. These are dynamically generated based on the name of the fields collected, which allows multi-language support. For example, if your company uses [ADDRESS_CURRENT], then all of the data keys will start with [APPLICANT_DATA_ADDRESS_CURRENT]. Examples can be seen below:

Merge Key

[APPLICANT_DATA_ADDRESS_CURRENT_POSTAL_CODE]

[APPLICANT_DATA_ADDRESS_CURRENT_CITY]

[APPLICANT_DATA_ADDRESS_CURRENT_STATE]

[APPLICANT_DATA_ADDRESS_CURRENT_APARTMENT_NUMBER]