Message Template Variables
General Info
We support a variety of variables for generated messages. Below you’ll find a full list of them with example usages. Variables will fall into a few different categories based on when they are replaced, where they can be used, and what types of values they return.
When does variable replacement happen?
Variables can either be replaced when the message is generated or just before the message is sent. Unless explicitly stated, all variables should be assumed to be replaced when the message is generated.
Using Variables
Variables can be used for either their value or as part of conditional logic to determine what content should be in the generated message. Most variables will return a formatted string with the relevant replacement, but some will return a True/False value and are only intended to be used with conditional template logic. Below is an example showing off both types of usages.
Template
Good {{time_of_day}} {{first_name}}, {% if available %}{{building_or_unit}} is still available! Schedule a tour: {{apptlink}}{% else %}Unfortunately {{building_or_unit}} is no longer available, but we have many other units available if you’re still interested in {{client_layouts}}.{% endif %}Thanks, Test Management {{company_website_url}}
Example 1
Good morning Steve, #123 of Some Fake Building is still available! Schedule a tour: http://nest.io/sched/4o-43kh/Thanks, Test Management https://www.nestio.com
Example 2
Good evening Jane, Unfortunately #321 of Some Fake Building is no longer available, but we have many other units available if you’re still interested in a Studio.Thanks, Test Management https://www.nestio.com
Supported Templates
- Initial Auto-Reply/Suggested Message
Section of Email | Supported Variables |
Email Subject |
Client ◦ Client First Name ◦ Client Last Name Listing ◦ Community Name ◦ Building Name ◦ Building or Unit ◦ Unit Number |
Email Header & Email Footer (Body content of email) |
Common ◦ Time of Day Company ◦ Company Guarantor Policy ◦ Company Website Client ◦ Client First Name ◦ Client Last Name Client Preferences ◦ Client Budget ◦ Client Layouts Listing ◦ Community Name ◦ Community Phone Number ◦ Community Email Address ◦ Community Website ◦ Community Photo URL ◦ Building Name ◦ Building or Unit ◦ Pet Policy ◦ Public Listing URL ◦ Resident Incentives ◦ Unit Available ◦ Unit Heat/Hot Water ◦ Unit Number Appointment Scheduling ◦ Appointment Scheduling Link Application Link Variables ◦ External Application Link ◦ Unit Level External Application Link Subscription Variables ◦ Email Unsubscribe Link |
- Marketing Automation
Section of Email | Supported Variables |
Email Subject |
Client ◦ Client First Name ◦ Client Last Name Listing ◦ Community Name ◦ Building Name ◦ Building or Unit ◦ Unit Number |
Email Header & Email Footer (Body content of email) |
Common ◦ Time of Day Company ◦ Company Guarantor Policy ◦ Company Website Client ◦ Client First Name ◦ Client Last Name Client Preferences ◦ Client Budget ◦ Client Layouts Listing ◦ Community Name ◦ Community Phone Number ◦ Community Email Address ◦ Community Website ◦ Community Photo URL ◦ Building Name ◦ Building or Unit ◦ Pet Policy ◦ Public Listing URL ◦ Resident Incentives ◦ Unit Available ◦ Unit Heat/Hot Water ◦ Unit Number Appointment Scheduling ◦ Appointment Scheduling Link Application Link Variables ◦ External Application Link ◦ Unit Level External Application Link Subscription Variables ◦ Email Unsubscribe Link |
- Message Templates & Blocks
Section of Email | Supported Variables |
Email Header & Email Footer (Body content of email) |
Common ◦ Time of Day Company ◦ Company Guarantor Policy ◦ Company Website Client ◦ Client First Name ◦ Client Last Name Client Preferences ◦ Client Budget ◦ Client Layouts Listing ◦ Community Name ◦ Community Phone Number ◦ Community Email Address ◦ Community Website ◦ Community Photo URL ◦ Building Name ◦ Building or Unit ◦ Pet Policy ◦ Public Listing URL ◦ Resident Incentives ◦ Unit Available ◦ Unit Heat/Hot Water ◦ Unit Number ◦ Community Video Tour URL ◦ Unit Video Tour URL ◦ Unit Type Special Offers Appointment Scheduling ◦ Appointment Scheduling Link ◦ Appointment Date and Time ◦ Appointment Location Link ◦ Appointment Meeting Location ◦ Appointment Confirmation Link Application Link Variables ◦ External Application Link ◦ Unit Level External ◦ Signup or Login Application Link Subscription Variables ◦ Email Unsubscribe Link Inventory Search ◦ Client Inventory Search User Sender ◦ Signature ◦ User Full Name ◦ User First Name ◦ User Phone Number |
When using variables within Funnel, the "Key" value must be present.
User Sender Variables | Variable | Key | Description |
Common Variables | Time of day | {{time_of_day}} | Adds the time of day (morning, afternoon, evening) when the message is generated. |
Company Variables | Guarantor Policy | {{company_guarantor_policy}} | Adds the ManagementCompany's guarantor_policy when the message is generated. |
Company Variables | Website | {{company_website_url}} | Adds the ManagementCompany's website when the message is generated. |
Client Variables | Client first name | {{first_name}} | Adds the client's primary person's first name when the message is generated. |
Client Variables | Client last name | {{last_name}} | Adds the client's primary person's last name when the message is generated. |
Client Variables | SMS Opt-In Link | {{sms_opt_in_link}} | Generates a link to a form where the client can enter a phone number to be opted into text messaging. Entering a phone number on that form will update the primary phone number on the client record and set SMS Marketing Opt-In = Marketing Enabled. |
Client Preferences Variables | Client Budget | {{client_budget}} | Adds a formatted message with the client's budget preferences (min/max) when the message is generated. |
Client Preferences Variables | Client Layouts | {{client_layouts}} | Adds a formatted message of the client's preferred layouts when the message is generated. Only supports these layouts: Studio 1 Bedroom 2 Bedroom 3 Bedroom |
Client Preferences Variables | Absolute Move In Date | {{client_move_in_absolute}} | Adds the Client's preferred move-in date |
Listing (Community, Building, or Unit) Variables | Community Name | {{community_name}} | Adds the name of the community when the message is generated. The most recent line item under "Listings" in the client card should populate this field. |
Listing (Community, Building, or Unit) Variables | Community Description | {{community_description}} | Adds community description when the message is generated. |
Listing (Community, Building, or Unit) Variables | Community Phone Number | {{community_phone_number}} | Adds the community phone number (Contact phone) when the message is generated. |
Listing (Community, Building, or Unit) Variables | Community Email Address | {{community_email_address}} | Adds the community email address (Contact email) when the message is generated. |
Listing (Community, Building, or Unit) Variables | Community Website | {{community_website_url}} | Adds the community website (Website url) when the message is generated. |
Listing (Community, Building, or Unit) Variables | Community Address | {{community_address_line_one}} {{community_address_line_two}} | Adds the community address when the message is generated. The building number and street are filled in for community_address_line_one . The city, state, and postal code are filled in for two . This is so that you can decide to format the address on one line if it's in the body of the message or on two lines if it's used in the signature of the email. |
Listing (Community, Building, or Unit) Variables | Community Special Offers | {{community_special_offers}} | Adds community's Special Offers. |
Listing (Community, Building, or Unit) Variables | Community Pets Allowed | {{community_pets_allowed}} | Returns True/False for whether pets are allowed at the community. This returns true if the Pets Allowed field for the community is any value except "No Pets Allowed", and false if the Pets Allowed field is "No Pets Allowed". |
Listing (Community, Building, or Unit) Variables | Community Pets Allowed Type | {{community_pets_allowed_type}} | If the Pets Allowed field = "Pets Allowed", this returns "pets" If the Pets Allowed field = "Cats Only", this returns "cats only" If the Pets Allowed field = "Dogs Only", this returns "dogs only" If the Pets Allowed field = "Cats/Small Dogs Allowed", this returns "cats and small dogs only" If the Pets Allowed field = "Pets Allowed Case By Case", this returns "pets on a case by case basis" If the Pets Allowed field = "No Pets Allowed", this returns "no pets" |
Listing (Community, Building, or Unit) Variables | Community Pets Max Allowed | {{community_pets_max_allowed}} | Adds community's Pets Max Allowed value. |
Listing (Community, Building, or Unit) Variables | Community Pets Deposit | {{community_pets_deposit}} | Adds community's Pets Deposit as dollar value. |
Listing (Community, Building, or Unit) Variables | Community Pets Deposit Dogs | {{community_pets_deposit_dogs}} | Adds community's Pets Deposit(Dogs) as dollar value. |
Listing (Community, Building, or Unit) Variables | Community Pets Deposit Cats | {{community_pets_deposit_cats}} | Adds community's Pets Deposit(Cats) as dollar value. |
Listing (Community, Building, or Unit) Variables | Community Pets Extra Rent | {{community_pets_extra_rent}} | Adds community's Pets Extra Rent as dollar value. |
Listing (Community, Building, or Unit) Variables | Community Pets Extra Rent Dogs | {{community_pets_extra_rent_dogs}} | Adds community's Pets Extra Rent(Dogs) as dollar value. |
Listing (Community, Building, or Unit) Variables | Community Pets Extra Rent Cats | {{community_pets_extra_rent_cats}} | Adds community's Pets Extra Rent(Cats) as dollar value. |
Listing (Community, Building, or Unit) Variables | Community Pets Fee | {{community_pets_fee}} | Adds community's Pets Fee as dollar value. |
Listing (Community, Building, or Unit) Variables | Community Pets Fee Dogs | {{community_pets_fee_dogs}} | Adds community's Pets Fee(Dogs) as dollar value. |
Listing (Community, Building, or Unit) Variables | Community Pets Fee Cats | {{community_pets_fee_cats}} | Adds community's Pets Fee(Cats) as dollar value. |
Listing (Community, Building, or Unit) Variables | Community Pets Breed Restrictions | {{community_pets_breed_restrictions}} | True/False value reflecting community's "Pets Breed Restriction" flag. |
Listing (Community, Building, or Unit) Variables | Community Pets Restrictions | {{community_pets_restrictions}} | Textual value for community's Pets Restrictions. |
Listing (Community, Building, or Unit) Variables | Community Pets Notes | {{community_pets_notes}} | Template: "Pets Notes: {{community_pets_notes}}" Ex 1: "Pets Notes: This community has some pets restrictions." |
Listing (Community, Building, or Unit) Variables | Community Washer Dryer Info | {{community_washer_dryer_info}} | Inserts a string consisting of a comma separated list based on the Washer/Dryer Info for the appropriate community. |
Listing (Community, Building, or Unit) Variables | Community Own Washer Dryer Allowed | {{community_own_washer_dryer_allowed}} | True/False value reflecting community's "Own Washer/Dryer Allowed" flag. |
Listing (Community, Building, or Unit) Variables | Community Laundry Notes | {{community_laundry_notes}} | Textual value for community's Laundry Notes. |
Listing (Community, Building, or Unit) Variables | Community Parking Info | {{community_parking_info}} | Inserts a string that consists of a list based on the Parking Info for the appropriate community. Each Parking Type that has been added for the community (with the exception of Touring Parking) display on its own line. |
Listing (Community, Building, or Unit) Variables | Community Parking Notes | {{community_parking_notes}} | Textual value for community's Parking Notes. |
Listing (Community, Building, or Unit) Variables | Community Leasing Deposit | {{community_leasing_deposit}} | Textual value for community's Leasing Deposit field. |
Listing (Community, Building, or Unit) Variables | Community Lease Term | {{community_lease_term}} | Textual value for community's Lease Term field. |
Listing (Community, Building, or Unit) Variables | Community Application Fee | {{community_application_fee}} | Textual value for community's Leasing Application Fee field. |
Listing (Community, Building, or Unit) Variables | Community Administrative Fee | {{community_administrative_fee}} | Textual value for community's Leasing Administrative Fee field. |
Listing (Community, Building, or Unit) Variables | Community Photo URL | {{community_photo_url}} | Adds the url for the community's first photo when the message is generated. |
Listing (Community, Building, or Unit) Variables | Community Year Built | {{community_year_built}} | Inserts community's Year Built field value. |
Listing (Community, Building, or Unit) Variables | Community Number of Floors | {{community_number_of_floors}} | Inserts number of floors in community's highest building. |
Listing (Community, Building, or Unit) Variables | Community Apartment Features | {{community_apartment_features}} | Textual value for community's Apartment Features field. |
Listing (Community, Building, or Unit) Variables | Community Electric Company | {{community_electric_company}} | Inserts community's Electric Company name. |
Listing (Community, Building, or Unit) Variables | Community Gas Company | {{community_gas_company}} | Inserts community's Gas Company name. |
Listing (Community, Building, or Unit) Variables | Community Telephone Company | {{community_telephone_company}} | Inserts community's Telephone Company name. |
Listing (Community, Building, or Unit) Variables | Community Cable Company | {{community_cable_company}} | Inserts community's Cable Company name. |
Listing (Community, Building, or Unit) Variables | Community Water Company | {{community_water_company}} | Inserts community's Water Company name. |
Listing (Community, Building, or Unit) Variables | Community Internet Company | {{community_internet_company}} | Inserts community's Internet Company name. |
Listing (Community, Building, or Unit) Variables | Community Paid Utilities | {{community_paid_utilities}} | Inserts list of utilities paid by community. |
Listing (Community, Building, or Unit) Variables | Community Not Paid Utilities | {{community_not_paid_utilities}} | Inserts list of utilities not paid by community. |
Listing (Community, Building, or Unit) Variables | Community Office Hours | {{community_office_hours}} | Inserts a multiline text representing the hours of operation of the group associated with the community. |
Listing (Community, Building, or Unit) Variables | Community Touring Hours | {{community_touring_hours}} | Inserts a multiline text representing the touring hours of the group associated with the community. |
Listing (Community, Building, or Unit) Variables | Community Tour Default Length | {{community_tour_default_length}} | Inserts community's tour default length in minutes. |
Listing (Community, Building, or Unit) Variables | Community Affordable Housing Offered | {{community_affordable_housing_offered}} | True/False value reflecting community's "Affordable Housing Offered" flag. |
Listing (Community, Building, or Unit) Variables | Community Affordable Housing Notes | {{community_affordable_housing_notes}} | Textual value for community's Affordable Housing Notes field |
Listing (Community, Building, or Unit) Variables | Community Neighborhood Selling Points | {{community_neighborhood_selling_points}} | Textual value for community's Neighborhood Selling Points field. |
Listing (Community, Building, or Unit) Variables | Community Office Closures | {{community_office_closures}} | Inserts a string representing the upcoming office closures for the group associated with the community. This only includes upcoming closures within the next 60 days. |
Listing (Community, Building, or Unit) Variables | Community Property Selling Points | {{community_property_selling_points}} | Inserts a list of community's selling points defined in "Property Selling Points" field. |
Listing (Community, Building, or Unit) Variables | Community Property Map URL | {{community_property_map_url}} | Inserts a URL of community's primary property map(if available). If no primary property map selected in admin for given community, falls back to first property map linked to that community. |
Listing (Community, Building, or Unit) Variables | Community Engrain Map URL | {{community_engrain_url}} | Inserts a URL of community's engrain map (if available). |
Listing (Community, Building, or Unit) Variables | Building Name | {{building_name}} | Adds the name of the building when the message is generated. |
Listing (Community, Building, or Unit) Variables | Building or Unit | {{building_or_unit}} | Adds the unit number when the message is generated. |
Listing (Community, Building, or Unit) Variables | Pet Policy | {{unit_or_building_pet_policy}} | The pets policy for the referenced unit or building when the message is generated. |
Listing (Community, Building, or Unit) Variables | Public Listing URL | {{public_listing_detail_url}} | Adds a link to the unit's marketing_url if available, otherwise adds a link to the public listing page for this company and unit. |
Listing (Community, Building, or Unit) Variables | Resident Incentives | {{unit_resident_incentives}} | Adds a formatted string containing the offered incentives for this unit when the message is generated. |
Listing (Community, Building, or Unit) Variables | Unit Available | {{available}} | A True/False value for whether the unit's status is AVAILABLE or PENDING when the message is generated. Generally this should be used in a conditional statement to included or exclude content. Note: If a specific unit was not collected for the prospect, this will evaluate to False. |
Listing (Community, Building, or Unit) Variables | Unit Heat/Hot Water | {{unit_heat_hot_water}} | A True/False value for whether the unit has Heat/Hot Water included when the message is generated. Generally this should be used in a conditional statement to included or exclude content. |
Listing (Community, Building, or Unit) Variables | Unit Number | {{unit_number}} | Adds the unit number when the message is generated. |
Listing (Community, Building, or Unit) Variables | Community Video Tour URL | {{community_video_tour_url}} | Inserts a URL of community's video tour link (if available). |
Listing (Community, Building, or Unit) Variables | Unit Video Tour URL | {{unit_video_tour_url}} | Inserts a URL of unit's video tour link if available. Link is extracted from primary_video_url field. |
Listing (Community, Building, or Unit) Variables | Unit Type Special Offers | {{unit_type_special_offers}} | Inserts Unit Type Special Offers if available. Value is extracted from incentives_marketing_description field on Unit Type. |
Appointment Scheduling Variables | Appointment Scheduling Link | {{apptlink}} | Generates a link to schedule an appointment for the associated client listing (building/unit) when the message is generated. |
Appointment Variables | Appointment Date and Time | {{tour_date_and_time_absolute}} | Generates a string indicating the date and time of the appointment start. |
Appointment Variables | Appointment Location Link | {{tour_location_map_link}} | Generates a link with the location of the appointment based on the first unit/building associated with the appointment |
Appointment Variables | Appointment Meeting Location | {{tour_location_map_link}} | The location that where the client should meet the agent. This is either set by the agent on the appointment in the Appointment Location field or we'll attempt to use the location of the first unit/building associated with the appointment. |
Appointment Variables | Appointment Confirmation Link | {{tour_confirmation_link}} | Appends a link to the appointment scheduler so the prospect can view, reschedule, or cancel their appointment. |
Appointment Variables | Tour Length | {{tour_length}} | Inserts appointment length in minutes(calculated based on start and end appointment field values. |
Application Link Variables | External Application Link | {{application_link}} | Adds a link to the external application_url (not Nestio online leasing) configured through the Community Admin page. |
Application Link Variables | Unit Level External Application Link |
{{unit_external_application_link}} | Adds a link to unit's external application_url (not Nestio online leasing) configured through the Unit Admin page. |
Subscription Variables | Email Unsubscribe Link | {{email_unsubscribe_link}} | Generates a link for the prospect that allows him/her to unsubscribe from all marketing automation emails. When the prospect clicks on the link, he/she will be unsubscribed from all marketing automation emails. The "Email Marketing Opt-In" field will be set to "Client Opted Out" for the prospect. There currently is no way to be opt back in. |
User Sender Variables | Signature | {{signature}} | Adds the user's signature (set on the email sync settings page) to a message. This variable is applied either right before we send the message for auto-sent messages or when a user views the suggested message in Nessenger to ensure we use the correct user's signature for sending. Note: This variable is only supported for emails, not for text messages. |
User Sender Variables | User Full Name | {{user_full_name}} | Adds the user's full name to a message. This variable is applied either right before we send the message for auto-sent messages or when a user views the suggested message in Messenger to ensure we use the correct user's full name for sending. |
Inventory Search | Client Inventory Search | {{client_inventory_search}} | Adds a list of up to 5 listings based on the preferences associated with that client. The results are only displayed if the client has at least one of the following preferences set: layout, budget, move-in date. If there are no results, nothing is displayed. The results include the property name, unit, a link to the unit, the layout, the number of bathrooms, the price, and the availability. |
Applicant variables | Applicant required income | {{applicant_required_income}} | Adds the required income of the applicant. This value is different for guarantors and all other applicants. |
Applicant variables | Applicant income requirements | {{applicant_income_requirements}} | Adds the income requirements of the applicant. This value is different for guarantors and all other applicants.Adds the required income of the applicant. This value is different for guarantors and all other applicants. |
Applicant variables | Applicant income requirements | {{applicant_incorrect_or_insufficient_sources_text}} | Adds incorrect of insufficient sources of the incomplete financial sources. |
Revised 5.17.2022 | Message Template Variables
Comments
0 comments
Please sign in to leave a comment.