Overview
Email Templates need a way to incorporate contact information into the final email that is to be sent. The way we do it is by unique identifiable text within an email template.
For example if your email template looked like: Hello %contact_name%. And your contact's name was William Riker, the result of the email template would be Hello William Riker.
User Merge Field Mappings
The following merge fields can be obtained with a call to /v1/users/:id.
| Merge field | JSON field |
|---|---|
%agent_name% | name |
%agent_first_name% | firstName |
%agent_last_name% | lastName |
%agent_email% | email |
%agent_phone% | phone |
Person Merge Field Mappings
The following merge fields can be obtained with a call to /v1/people/:id.
| Merge field | JSON field |
|---|---|
%contact_name% | name |
%contact_first_name% | firstName |
%contact_last_name% | lastName |
%contact_email% | emails[0].value |
%contact_phone% | phones[0].value |
%contact_address% | Combination of Fields:addresses[0].street addresses[0].city, addresses[0].code |
%contact_street% | addresses[0].street |
%contact_city% | addresses[0].city |
%contact_state% | addresses[0].state |
%contact_zipcode% | addresses[0].code |
%contact_country% | addresses[0].country |
%source_name% | source |
Inquiry Merge Field Mappings
The following merge fields can be obtained with a call to /v1/events/:personId
| Merge field | JSON field |
|---|---|
%inquiry_address% | property.street |
The inquiry address merge field is intended to be used as the subject of an email without any surrounding text, it should perform some basic substitutions in case there is no inquiry event for the person:
- If
property.streetis empty and%source_name%is not empty, then:%inquiry_address%is "Your property inquiry from%source_name%". - If both
property.streetis empty and%source_name%are empty, then:%inquiry_address%is "Your property inquiry".