Supported fields for lead import can be used with all three general import methods
NOTE These fields and values should not be used with widgets or on websites as filters etc.
- Form Submit
Used when any HTML FORM is submitted from a website. (Form Submit) - Email import
This allows structured emails to be used to import lead data. (Email Import ) - API
This method is typically executed from a system. (Lead Import API)
This support article lists all available fields and their applicability to each import method.
Lead Import Actions
When a lead is imported, these are the key actions that can occur.
Follow the links for these sections to see the fields and values required in each case.
Then add these fields and values to your forms etc.
- Create a Lead Profile and Contact
- Assign the Lead
- Marketing Tracking
- Record details about the Inquiry
- Categorize and Classify the Lead
- Decide how to process the lead
- Set up Property Alerts for the lead
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: Email and API Import
- Lead Import API Key ("api_key") used to authorize the import to your account.
- Lead Import API Key ("api_key") used to authorize the import to your account.
All other fields are optional.
NOTE: the "Lead Import API Key " for lead import is user-specific and is shown on the Users' Profile tab in User Preferences.
Email Import Template
Click here for a email template with all the fields.
Lead Profile and Contact
| Reference Name | Field Name | Values | Description and Notes |
|---|---|---|---|
| Lead Import ID | api_key | {lead-import-id} | A User's Lead Import ID 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 | {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 Buying Buddy dashboard 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 | workphone | 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 Lead Import API Key being used.
- Or, you may use the parameters below to set Referral IDs (mbbuser), and/or other specific Role Assignments.
- Or, you may set the parameter to use the Round Robin established in your account.
With this approach you must use a Lead Import API Key from an Admin user in your account.
mbbuser | assistant | loanofficer | other (optional)
Buying Buddy 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
- cd45Tu is the referral ID for Bob Smith.
Lead will be assigned to Bob Smith as the primary 'Agent' role - fg6TYh is referral ID for Jim Jones.
Lead will be assigned to Jim Jones in the "Assistant" role.
| Reference Name | Field Name | Values | Description and Notes |
|---|---|---|---|
| Agent assigned | mbbuser | {referral_ID} | The Buying Buddy Referral ID is for the primary Agent assigned to the lead. |
| mbbagent | |||
| Assistant assigned | assistant | {referral_ID} | The Buying Buddy Referral ID is the Referral ID is for the user to have the Assistant role. |
| Loan Officer assigned | loanofficer | {referral_ID} | The Buying Buddy Referral ID is for the user to have the Loan Officer role. |
| Other assigned | other | {referral_ID} | The Buying Buddy 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 Lead Import ID and User Referral ID used for assignment will be ignored. |
Marketing Tracking
| Reference Name | Field Name | 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. |
Note: Search for leads matching Campaign Source using the Lead Advanced Search form. The Campaign Source is shown on the Lead Profile panel under Registration Summary.
Inquiry Details
| Reference Name | Field Name | 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
| Reference Name | Field name | 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
| Reference Name | Field Name | 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} | Buying Buddy 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} | Buying Buddy Campaign ID to assign to NEW lead. If no campaign ID is specified, no campaign will be assigned. |
| campaign (email) | |||
| Campaign for Existing Lead | campaign_existing | {campaign_id} | Buying Buddy 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
| Reference Name | Field Name | 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 | |||
| Buying Buddy MLS ID* | mls_id | {your_BB_mlsid} | **IMPORTANT** mls_id is required. The Buying Buddy defined "mls_id" for your MLS Use the Widget Wizards to identify the value for your MLS. 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 | 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. |