Supported fields for lead import can be used with all three general import methods:

  1. The API method is typically executed in PHP and is also used by our Zapier API. (API Import)
  2. The Form Submit method is used when any HTML FORM is submitted from a website. (Form Submit)
  3. The Email import method allows structured emails to be used to import lead data. (Email Import )

This support article lists all available fields and their applicability to each import method.

Mandatory Fields

  • Name of lead as ONE of the following options (depends on method)
    • "name" (full name of lead)
    • or "fname" (first name of lead)
    • or "lname" (last name of lead)
    • or both "fname" and "lname"

Additional Mandatory Fields for: API and Email Import

  • Import-API key ("api_key") used to authorize the import to your account.
    NOTE: Import-API key for lead import is user-specific and is shown on the Users' Profile tab in User Preferences.
    If you wish to post lead data for your account (e.g. for use with Round Robin), you should use an Import-API key from the main admin / account holder.

Optional Fields

All other fields are optional. However, remember this page is a reference for Fields, you must make sure you follow instructions for each method.

Email API Template

Click here for a email template with all the fields.

Lead Profile and Contact

This table shows the fields you can use marked as: .
Unsupported Field Names are marked as: . For some methods, Field Names are different or may not be supported.

Reference Name Field Name API Email Form Values Description and Notes
Import-API key api_key       {api_key} A User's Import API key that is used to authorize the import to your account
Assigned Website site_url       {text_string} This is the website the Lead is assigned to when an account has multiple authorized domains. Do NOT include the "www"
siteurl      
Email Address email       {text_string} Email address of lead
Full Name name       {text_string} The full name (use this or specify parts).
First Name fname       {text_string} First name of lead
first_name      
first_nm      
Last Name lname       {text_string} Last name of lead
last_name      
last_nm      
Password password       {text_string} If this is NOT included then the password will be auto-generated in the LAC when the account is created and will be shown in the 'welcome email' that is sent to the consumer.
Address address       {text_string} Street address of lead
Address-2 (e.g. Unit #) address2       {text_string} Additional address details of lead
City city       {text_string} City of lead
State state       {2-character} 2 character state code of lead
Zip zip       5 digits Zip code of lead
Primary Phone phone       xxx-xxx-xxxx Primary phone number for the lead
Mobile Phone mobilephone       xxx-xxx-xxxx Mobile phone of the lead
mobile_phone      
Work Phone         xxx-xxx-xxxx Work Phone of the lead
Home Phone homephone       xxx-xxx-xxxx Home phone of the lead
home_phone      

Lead Assignment

This only applies to multi-user accounts.

  • If nothing is specified then the lead is assigned according to the User's Import-API key being used.
  • Or, you may use the parameters below to set mbbuser (and/or other specific Role Assignments.
  • Or, you may set the parameter to use the Round Robin established in your account. Even with this approach you must still use an Import-API key from a user in your account. We would recommend the main admin user.

mbbuser | assistant | loanofficer | other - (optional) MBB Referral IDs, where each Referral ID listed must represent a user with a different ROLE (see User Roles) (A multi-user account allows multiple Users (who must have different Roles - Agent, Loan Officer, Asst etc) to be assigned the same lead). For Example:

mbbuser:cd45Tu assistant:fg6TYh - Where Bob Smith is to be the primary assigned 'Agent' (role = real estate agent) with Referral ID of cd45Tu - Jim Jones is to be the 'Assistant' (role = assistant) with Referral ID of fg6TYh

This table shows the fields you can use marked as: .
Unsupported Field Names are marked as: . For some methods, Field Names are different or may not be supported.

Reference Name Field Name API Email Form Values Description and Notes
Agent assigned mbbuser       {referral_ID} The MBB Referral ID is for the primary Agent assigned to the lead.
mbbagent      
Assistant assigned assistant       {referral_ID} The MBB Referral ID is the Referral ID is for the user to have the Assistant role.
Loan Officer assigned loanofficer       {referral_ID} The MBB Referral ID is for the user to have the Loan Officer role.
Other assigned other       {referral_ID} The MBB Referral ID is for the user to have the Other role.
Round Robin distribution round_robin       0 | 1 Numeric value: Set to "1" if this method is to be used for lead assignment. If set, then assignment of the lead will be processed by the round robin system and mbbuser value, and the Import-API key and User Referral ID used for assignment will be ignored.

Marketing Tracking

This table shows the fields you can use marked as: .
Unsupported Field Names are marked as: . For some methods, Field Names are different or may not be supported.

Reference Name Field Name API Email Form Values Description and Notes
Sign Up Page URL source_url       {text_string} URL of the domain or page the lead registered on
Campaign Source ad_campaign       {text_string} Name of your (advertising) campaign that originated the lead *NO SPACES ALLOWED*. This parameter is designed to help track sources of traffic.

Inquiry Details

This table shows the fields you can use marked as: .
Unsupported Field Names are marked as: . For some methods, Field Names are different or may not be supported.

Reference Name Field Name API Email Form Values Description and Notes
Inquiry Subject request_subject       {text_string} This is used if there was a request or form submitted.
form_nm      
Inquiry Details request_details       {text_string} The information submitted in a form or information about the inquiry
Task Status request_status       0 | 1 0 (default) creates a "due" task showing in the "Tasks" tab. If you make this "1" it will be marked complete.
Task Due request_due       {integer} Number of days. How many days in future this task will be due. If a future period is not specified then the period is zero and the task will be due today.
Notes (history) notes       {text_string} Creates a note in the "Note" tab
Profile Comments comments       {text_string} Sticky Comments on the Lead Profile tab

Lead Profiling

This table shows the fields you can use marked as: .
Unsupported Field Names are marked as: . For some methods, Field Names are different or may not be supported.

Reference Name Field name API Email Form Values Description and Notes
Star Rating rating       1 | 2 | 3 | 4 | 5 Set this to be the STAR rating for this lead. Values can be one of: 1 (default),2,3,4,5
Category ID category       {id_number} Set to be a Category ID established in your account, e.g. "126" or "126,467"
Tags tags       {text_string} Comma separated list of tag keywords to be applied to lead
Buyer Status buyer_status       1 | 2 | 3 | 4 | 5 1=Now, 2=Within three months, 3= Three to Six Months, 4=Six to Twelve months, 5= More than a year
Mortgage Status mortgage_status       1 | 2 | 3 1=Need one, 2=Prequalified, 3=None
Agent Agreement agent_status       0 | 1  0=Not sure or does not have an agent agreement in place, 1=Does have agent agreement in place

Lead Processing

This table shows the fields you can use marked as: .
Unsupported Field Names are marked as: . For some methods, Field Names are different or may not be supported.

Reference Name Field Name API Email Form Values Description and Notes
Match to Existing match_existing       false | true If "true", this ONLY imports if the lead already exists, i.e. if "true" then this will not import unless this lead is already in the account. Consequently, if set to "true", then leads are never created - existing leads are only updated with additional notes, inquiries and comments for a lead.
Welcome Email welcome_email       false | true 0 / false =Don't send welcome email (default), 1 / true =Send welcome email
**IMPORTANT** The "Welcome email" is the standard system 'auto-responder" email which cannot be changed. To send a specific single email as your immediate follow up email, you should create an email template and use the option to "Send Additional Email"
welcome_email       0 | 1
Send Additional Email template_id       {template_id} LAC email Template ID to be sent to the lead immediately (can be applied as-well-as, or instead-of Welcome email)
Campaign for New Lead campaign_id       {campaign_id} LAC Campaign ID to assign to NEW lead. If no campaign ID is specified, no campaign will be assigned.
campaign      
Campaign for Existing Lead campaign_existing       {campaign_id} LAC Campaign ID to assign to an EXISTING lead. If no campaign ID is specified, no campaign will be assigned.
Campaign is to be the only Campaign only_campaign       0 | 1 Numeric value: 0= allow multiple campaigns (default), 1=Delete all other campaigns

Create Property Alerts

IMPORTANT! The following fields are currently NOT part of the API import field set, they are however supported when used in a Custom Lead Capture form or when using Email import methods.

This table shows the fields you can use marked as: .
Unsupported Field Names are marked as: . For some methods, Field Names are different or may not be supported.

Reference Name Field Name API Email Form Values Description and Notes
Save Search save_custom_search       1 Setting "1" will create a "Just Listed Property Alert" for the lead based on the MLS criteria that must also be submitted in the Form.
Name of Search saved_search_nm       {text_string} This option allows you to give the saved search/alert a name. {name_of_search} = any text string. If not specified, the search alert name will be "First Saved Search".
Frequency of Alert frequency       instant | daily | weekly | monthly This option allows you to set the frequency of the alert. {frequency} = instant | daily | weekly | monthly. The default value if not specified is "daily".
saved_search_frequency      
Duration of Alert duration       1 to 18 This option allows you to set the duration of the alert in months - i.e. how many months the alert executes. {months} = any number, from 1 to 18. The default value is 6.
saved_search_duration      
End Date (alternative) end_dt       mm-dd-yy Alternative. Specify an actual end date INSTEAD of "duration"
saved_search_end_dt      
MBB MLS ID mls_id       {your_MBB_mlsid} The MBB defined "mls_id" for your MLS Use the Widget Wizards to identify the value for your MLS.
      {your_MBB_mlsid} For Email import DO NOT specify as a standalone field, instead you must include the mls_id as part of the filter - see below.
MLS Criteria (various)         Specify MLS criteria using field NAME and VALUEs. for example, to submit a minimum price of $1million... <input type="hidden" name="price_min" value="1000000"> Use the Widget Wizards to identify the correct field names and values to use for your MLS.
saved_search_filter)         Include mls_id as part of your filter. Specify a normal search filter. For example, to submit a minimum price of $1million... mls_id:tx492+price_min:1000000. Use the Widget Wizards to create a filter.

Admin