Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Merge Fields

Merge fields let one template address every lead personally. Write a field in double curly braces, for example {{contact.first_name}}, in a template's subject or body. When the email is sent, PeakIDX replaces it with that lead's value.

Rules for merge fields:

  • A field you misspell, or one that has no value for the lead, is replaced with empty text. It does not show as {{...}} in the email.
  • In the email body, values are made safe for HTML, so a name containing special characters cannot add code to the email. In the subject line, values are inserted as plain text.
  • Spaces inside the braces are allowed ({{ contact.first_name }}). Field names are lowercase and are case sensitive.
  • URL fields such as {{unsubscribe_url}} or {{listing.url}} are most useful inside a link: <a href="{{listing.url}}">View the home</a>.

Lead and Contact Fields​

FieldValue
{{contact.first_name}}The lead's first name.
{{contact.last_name}}The lead's last name.
{{contact.full_name}}First and last name together.
{{contact.email}}The lead's email address.
{{contact.phone}}The lead's phone number.
{{contact.city}}The city on the lead's contact record, if there is one.
{{lead.type}}The lead type name, for example Inquiry, CMA Inquiry or Agent Inquiry.

Agent Fields​

The agent is the user the lead is assigned to. If the lead is not assigned, the site's default lead user is used.

FieldValue
{{agent.name}}The agent's full name.
{{agent.first_name}}The agent's first name.
{{agent.phone}}The agent's phone number.
{{agent.email}}The agent's email address. This is also used as the reply-to address.

Property Fields​

For drip campaigns, these describe the listing the lead asked about, when there was one. If the lead did not ask about a listing they are empty, and {{listing.url}} is your site's home page. In saved-search alerts they describe the matching listing.

FieldValue
{{listing.address}}Street address and city.
{{listing.price}}The price, formatted like $425,000.
{{listing.beds}}Bedrooms.
{{listing.baths}}Bathrooms.
{{listing.sqft}}Square feet.
{{listing.url}}A link to the listing on your site.
{{listing.photo_url}}The listing photo address. Filled in for alerts, empty otherwise.
{{property.address}}Same as {{listing.address}}. Used in the post-close starter templates.

Site and Compliance Fields​

FieldValue
{{site.name}}Your company name, or the site name if there is no company name.
{{unsubscribe_url}}The recipient's personal unsubscribe link.
{{site.url}}Your site address, for example https://www.example.com.
{{site.phone}}The contact phone number saved for the site. Empty if none is saved.
{{postal_address}}The postal address saved for the site.
{{appointment_url}}Your public booking page, without a person pre-selected.
{{recommended_listings_url}}The link to the contact's recommended listings page on your site. Available in the listing recommendation email.

Saved-Search Alert Fields​

These are meant for the three listing alert templates.

FieldValue
{{alert.match_count}}The number of new matching homes.
{{alert.frequency}}How often the person receives alerts, for example daily.
{{alert.search_summary}}A short description of the saved search.
{{alert.results_url}}A link to the page of new matching homes.
{{alert_settings_url}}A link to change or pause the alerts.

In campaign emails the three alert.* fields are empty. In the daily or weekly digest, wrap a repeating block in {{#each listings}} and {{/each}}. The block is repeated once per matching listing, and the listing.* fields inside it refer to each listing in turn:

{{#each listings}}- {{listing.address}}, {{listing.price}}: {{listing.url}}
{{/each}}

Appointment Fields​

These work in the appointment confirmation and reminder templates.

FieldValue
{{appointment.type}}The appointment type, for example Showing.
{{appointment.date}}The date, for example Saturday, October 31, 2026.
{{appointment.time}}The start time with the site time zone, for example 2:00 PM CDT.
{{appointment.location}}The location text entered on the appointment.
{{appointment.ics_url}}A link that downloads a calendar file for the appointment.
{{appointment.reschedule_url}}The guest's private link to view and cancel the appointment.

For appointment emails, the contact fields come from the guest's name, email and phone on the appointment, and the agent fields come from the person the appointment is with.

Fields That Are Not Filled In Yet​

The "Open house invitation" starter template uses {{event.day}}, {{event.date}}, {{event.start}} and {{event.end}}. No part of PeakIDX supplies values for these today, so they come out empty. Edit that template before you use it.

You do not have to put the unsubscribe link in a marketing template yourself. If the body of a marketing template does not contain PeakIDX's unsubscribe link, PeakIDX adds a footer with the unsubscribe link and your postal address automatically. If you add {{unsubscribe_url}} to a link yourself, no second footer is added; remember to include {{postal_address}} in that case. See Unsubscribe and Opt-In.