While creating date templates, emails, and email templates, you will utilize merge field codes to pull the correct information from the transaction. This article will explain how to use merge field codes and provide merge field code lists.
Note: Capitalization in the merge field code is important—it must match exactly to ensure it connects properly and pulls the correct information! You will know when it properly connects, as a dropdown menu will appear after you type $ to select the merge code you want to use.
TABLE OF CONTENTS
- Related Videos
- Using Merge Field Codes
- Date Merge Field Codes
- Contact Merge Field Codes
- Transaction Merge Field Codes
- Account Merge Field Codes
Related Videos
Here are some related videos you may find helpful:
Using Merge Field Codes
Emails
When creating an email, using merge field codes can save a lot of time and effort. Merge field codes allow you to personalize the email by automatically populating information into the email. To use merge field codes, simply insert them into the email template or email directly & it will populate the information specific to the transaction or contacts you are creating the email for. The merge field codes can pull different information, such as contact information, transaction dates, transaction information cells, and auto-attach attachments. For AFrame merge field codes, use the format: $CustomMergeCode.
Related Articles: Email/Letter Templates, Email Tab
Dates
Each date entry has a custom merge field code associated with it. With this code, you can define what it will be, and you can reference it in email templates or even use it within due date formulas for other date entries or tasks. To help you identify the type of code, the date merge field codes start with the prefix $d_.
Related Articles: Date Templates, Dates Tab
Tasks
When creating tasks, there are two options for due dates: no due date or due date formulas. When choosing the due date formula, you have the option to select a referenced date. The reference date is a date entry or standard date (such as list date, effective date, template start date, closing date, or any custom date made) that will have its unique merge field code associated with it.
Related Articles: Task Templates, Task Tab
Attachments
Each attachment entry has a unique custom merge field code associated with it. This code allows you to define a placeholder for the attachment and reference it within email templates. When you include the merge field in an email template, the corresponding file will automatically be attached, as long as a file has been uploaded to that specific placeholder. This streamlines the process and ensures relevant documents are included in communications. To help you identify the type of code, the attachment merge field codes start with the prefix $a_.
Related Articles: Attachment Templates, Attachments Tab, Email/Letter Templates
Information Fields
Each information field has a unique custom merge field code that acts as a placeholder for that field. Similarly, each group of fields has its own custom merge field code. When you use a field group merge field code, it automatically inserts data from all fields within the group that contain information, while excluding empty fields. To help you identify the type of code, individual field codes start with the prefix $f_, and group field codes begin with $fg_.
Related Articles: Field Definitions Templates, Information Fields, Email/Letter Templates
Date Merge Field Codes
These are the date entries in the default date template for each account. You can always create custom dates with their own custom merge field codes within the date templates. There are optional suffixes for the date merge field codes to help with more conversational formats for emails.
Standard Transaction Dates Codes | |
---|---|
Date | Merge Code |
List Date | $d_ListDate |
On Market Date | $d_OnMarketDate |
Expire Date | $d_ExpireDate |
Effective Date | $d_EffectiveDate |
Closing Date | $d_ClosingDate |
Default Contract Date Template Codes | |
---|---|
Date | Merge Code |
Earnest Money Due | $d_EarnestMoneyDue |
Inspection Period | $d_InspectionPeriod |
Survey Date | $d_SurveyDate |
Finance Date | $d_FinanceDate |
Title Date | $d_TitleDate |
Possession Date | $d_PossessionDate |
Optional Suffixes for Date Merge Codes (above chart) | ||
---|---|---|
Data | Suffix On Merge Code | Format |
No Suffix | Sep 23, 2023 (Sat) from 9:00 am - 12:00 pm | |
Due Date Formula | -Formula | 7 Calendar Days |
Starting Date | -StartDate | Sep 8, 2023 (Fri) |
Starting Date Order | -StartDateOrd | Friday, September 8th |
Starting Time | -StartTime | 9:00 AM |
Location | -Location | Address entered in Location Cell |
ProTip: You can create multiple date templates in your account with custom dates to apply to your transactions, which is beneficial when you cover multiple states/areas with different contract dates.
Related Articles: Date Templates, Email/Letter Templates
Contact Merge Field Codes
Add the Prefix (including -) and Suffix together to pull the correct information (i.e., $UserAssistant1-FirstName).
Participant Tab Codes | |
---|---|
Data | Merge Code |
All Participants | $TransactionParticipants |
Agent Portal Visible Participants | $TransactionParticipants-AgentPortal |
Buyer/Seller Portal Visible Participants | $TransactionParticipants-BuyerSellerPortal |
All Participants + Agent/TC Roles | $TransactionParticipantsAndUsers |
Agent Portal Visible Participants + Agent/TC Roles | $TransactionParticipantsAndUsers-AgentPortal |
Buyer/Seller Portal Visible Participants + Agent/TC Roles | $TransactionParticipantsAndUsers-BuyerSellerPortal |
General Contact Codes | ||
---|---|---|
Data | Merge Code | Format |
First Name | $FirstName | John |
Last Name | $LastName | Smith |
First & Last Name | $FullName | John Smith |
First Names | $FirstNames | John, Jane |
First & Last Names | $FullNames | John Smith & Jane Smith |
Last Names | $LastNames | Smith / Doe & Smith |
Salutation Letter | $SalutationLtr | John & Jane |
Salutation Envelope | $SalutationEnv | John & Jane Smith |
Basic Contact Info (Primary + Spouse) | $List | John Smith (Company), Phone Number, Email Jane Smith (Company), Phone Number, Email |
Extended Contact Info (Primary + Spouse) | $Card | Company John Smith Phone Number Address |
Tip: Using general contact merge field codes without the participant role prefix will pull the Buyer or Seller's information based on the transaction side.
User Role Codes | |||
---|---|---|---|
Prefix | Suffix | ||
User Role | Merge Code | Data Reference | Merge Code |
Primary Agent | $UserPrimaryAgent- | First Name | FirstName |
Co-Agent | $UserCoAgent- | Last Name | LastName |
TC/Assistant 1 | $UserAssistant1- | Full Name | FullName |
TC/Assistant 2 | $UserAssistant2- | Mobile | Mobile |
Portal Link | PortalLink | ||
Info in Vertical List | Card | ||
Info in Horizontal List | List |
Participant Role Codes | |||
---|---|---|---|
Prefix | Suffix | ||
Participant Role | Merge Code | Data Reference | Merge Code |
Buyer | $Buyer- | First Name | FirstName |
Seller | $Seller- | Last Name | LastName |
Primary Agent | $UserPrimaryAgent- | Full Name | FullName |
Agent (Other Side) | $AgentOtherSide- | Spouse First Name | SpouseFirstName |
TC/Assistant 1 | $UserAssistant1- | Spouse Last Name | SpouseLastName |
TC/Assistant 2 | $UserAssistant2- | Spouse Full Name | SpouseFullName |
Closer | $Closer- | First Names | FirstNames |
Closer (Other Side) | $CloserOtherSide- | Last Names | LastNames |
Attorney | $Attorney- | Full Names | FullNames |
Attorney (Other Side) | $AttorneyOtherSide- | Phone | Phone1 |
Lender | $Lender- | Spouse Phone | SpousePhone1 |
Lender (Other Side) | $LenderOtherSide- | ||
Inspector | $Inspector- | Spouse Email | SpouseEmail |
Surveyor | $Surveyor- | All Emails | AllEmails |
Brokerage | BrokerName | ||
Salutation Letter | SalutationLtr | ||
Salutation Envelope | SalutationEnv | ||
Mailing Full Address | FullMailingAddress | ||
Mailing Street Address | MailingAddress | ||
Mailing Address - City, State, Zip | MailingCSZ | ||
Extended Contact Info (Vertical) | Card | ||
Basic Contact Info (Horizontal) | List |
Note: You can add custom participant roles with their own Merge Field Code Prefixes under your List settings.
Open in AFrame: Admin > Lists > Transactions > Participant Roles
Related Articles: Lists :: Participant Roles
Transaction Merge Field Codes
These merge codes will pull the transaction data.
General Transaction Codes | |
---|---|
Data | Merge Code |
Transaction Side | $TransactionSide |
Contract Price | $ContractPrice |
List Price | $ListPrice |
Property Full Address | $PropertyFullAddress |
Property Street Address | $PropertyAddress |
Property Address - City, State, Zip | $PropertyCSZ |
Transaction Dates | $TransactionEvents |
Dates Visible in Agent Portal | $TransactionEvents-AgentPortal |
Dates Visible in Buyer/Seller Portal | $TransactionEvents-BuyerSellerPortal |
Information Field Codes | ||||
---|---|---|---|---|
Collection | Group | Field | ||
Name | Merge Code | Name | Merge Code | |
Transaction Info | Listing Details | $fg_ListingDetails | MLS Id | $f_MlsId |
Lockbox Id | $f_LockboxId | |||
Lockbox Info | $f_LockboxInfo | |||
Security | $f_Security | |||
Occupancy | $f_Occupancy | |||
Remarks | $f_Remarks | |||
Instructions | $f_Instructions | |||
Listing Other Info | $f_ListingOtherInfo | |||
Transaction Source | $f_TransactionSource | |||
Property Details | $fg_PropertyDetails | Property Type | $f_PropertyType | |
Subdivision | $f_Subdivision | |||
County | $f_County | |||
Tax Id | $f_TaxId | |||
Beds | $f_Beds | |||
Baths | $f_Baths | |||
Year Built | $f_YearBuilt | |||
Sqft | $f_Sqft | |||
Sqft Source | $f_Sqft | |||
Lot Desc | $f_LotDesc | |||
Schools | $f_Schools | |||
HOA Info | $fg_HOAInfo | HOA Fee | $f_HOAFee | |
HOA Frequency | $f_HOAFrequency | |||
Contract Info | Contract Details | $fg_ContractDetails | Escrow Number | $f_EscrowNumber |
Earnest Money | $f_EarnestMoney | |||
Due Diligence Fee | $f_DueDiligenceFee | |||
Other Party | $f_OtherParty | |||
Financing | $f_Financing | |||
Concessions | $f_Concessions | |||
Special Provisions | $f_SpecialProvisions | |||
Possession | $f_Possession | |||
Contract Other Info | $f_ContractOtherInfo | |||
Commission Note | $f_CommissionNote |
Tip: You need to add -List or -Grid suffix on end of field group merge codes to format field data of that group within your email templates. The field group merge field codes will not populate empty fields.
Note: You can customize your transaction fields that populate in your Information sidebar of the transaction with your List Settings and Field Definition Template.
Payout Codes | |
---|---|
Data | Merge Code |
Commission Percentage | $PercentageCommission |
Referral Payout | $ReferralPayout |
Actual Payout | $ActualPayout |
Broker Payout | $BrokerPayout |
Broker Payable | $BrokerPayable |
Team Lead Payout | $TeamLeadPayout |
Team Lead Payable | $TeamLeadPayable |
Primary Agent Payout | $PrimaryAgentPayout |
Primary Agent Payable | $PrimaryAgentPayable |
Co-Agent Payout | $CoAgentPayout |
Co-Agent Payable | $CoAgentPayable |
Assistant 1 Payout | $Assistant1Payout |
Assistant 1 Payable | $Assistant1Payable |
Assistant 2 Payout | $Assistant2Payout |
Assistant 2 Payable | $Assistant2Payable |
Related Articles: Field Definitions Templates, Information Fields, Payout Tab, Lists
Account Merge Field Codes
These general account merge field codes can be used in emails or email templates.
Account Codes | ||
---|---|---|
Data | Merge Code | Note/Format |
Company Name | $CompanyName | The AFrame account's company name |
Team Phone | $TeamPhone | The AFrame account's phone number |
Current Date | $CurrentDate | October 25, 2023 |
$CurrentDateLong | Wednesday, October 25, 2023 | |
$CurrentDateShort | 10/25/2023 | |
Managed Agent Portal | $ManagedAgentPortalLink | Main portal login URL. Agent-specific portal can be searched by email. |
Need help? We're here for you! Email us at Support@AFrameSoftware.com or use the ? icon in the top right of your AFrame account to submit a help request form.