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.

What's Covered

• Insert Merge Keys
• Merge Key Groups

Insert Merge Keys

1. Go to the Message Template you want to add the Merge Key in. 
   
2. Under Insert Merge Keys, click on the Merge Key Group that contains the Merge Key you want to insert. A drop-down of the different Merge Keys you can input will appear.
   
3. After adding the merge keys, click Save Message.

 

Merge Key Groups

We support the following groups of merge keys. Stage messages 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 required keys will show under Insert Merge Keys on the leftmost tab. Merge Key Groups may vary depending on integration and stage this message is for. 

 

Opening Keys

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

 

 

Applicant Keys

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

[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)

[ADVANCE_URL]

Advances applicant to the next stage.

 

Scheduler Keys

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

[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])

 

[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) 

[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)

[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)

[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
[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

 

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])

[DOCUMENT_SIGNING_LINK]

Document signing link for our in-app integration (can only be used as a standalone link)

 

Learning Stage Keys

(Lesson.ly & 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])

[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)

 

Posthire Keys

[POSTHIRE_CHECK_EXPIRATION_DATE]	Used to insert the expiration date of the document
[POSTHIRE_DATA_COLLECTION_FORM_URL]	Used to send the URL for the data collection page
[POSTHIRE_DATA_COLLECTION_FORM_LINK]	Used to send the link for the data collection page (cannot be used in a hyperlink)
[POSTHIRE_RULE_TITLE]	Used to insert the name of the recollection rule

 

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 be [APPLICANT_DATA_KEY].