This action may lead to changes in the database
Do you want to continue?
Data Explorer
Request Information
Generates Leads. This endpoint will force security, so, a PartnerId and SessionToken are mandatory. Note: Any Lead Action can be applied to any Lead Type
Body Parameters
Lead Information
ApiLeadName | Description | Type | Additional information |
---|---|---|---|
PartnerId |
Used for getting and saving the partner info on the lead created |
integer |
Required |
LeadPostingPassword |
Lead Posting Password |
string |
None. |
ShowMatchingCommunities |
Saved inside Lead Information. Send as true only when the partner Id is NHS, Move or CNA. |
boolean |
None. |
GoogleUtmz |
Cookies stored by Google Analytics |
ApiGoogleUtmz |
None. |
LeadAnalytics | ApiLeadAnalytics |
None. |
|
AlertId |
Used only when the Lead Type is Market, used by NHS to send Alerts for market name o market Id. |
string |
None. |
PrefState |
Used by NHS, when getting lead information from user session. |
string |
None. |
PrefCity |
Favorite City, saved as user preferences |
string |
None. |
LeadType |
Defines the lead type to create. |
string |
Required |
LeadAction |
Defines the lead action, that can be applied |
string |
None. |
IsMobileLead |
Is Mobile Site Lead? |
boolean |
None. |
IsChat | boolean |
None. |
|
LeadComments |
The text send here is added as user preferences |
string |
None. |
LeadBaseComments |
Accepts any comment, which will be added with some other useful data like the lead action used. It is always generated by the process followed when the lead is being generated |
string |
None. |
LeadUserInfo |
Object sent with the user information |
ApiLeadUserInfo |
None. |
MarketId |
It is used to save in user preferences |
integer |
None. |
BldrImportance |
Builder importance, saved inside user preferences |
string |
None. |
MoveInDate |
Date when the user want to move, saved inside user preferences |
string |
None. |
PrefPriceRange |
Preference price range, save as user preference. Used by NHS, inserted from profile |
string |
None. |
FinancePref |
User finance preference, saved inside user preferences, the value should be different to 0 |
string |
None. |
Reason |
Saved inside user preferences |
string |
None. |
FromPage |
Saved inside site information. Page from the lead was requested. Vales used on NHS: OnPageCd (Default) - OnPageHd (Seted when the lead type is Home) |
string |
None. |
Referer |
Inserted in site information. Used in NHS, get the value from UserSession object. The value save used on NHS is "Refer" |
string |
None. |
BuilderList |
Builder Ids, splited by ",". Only can be used if lead type is builder (rcb). |
string |
None. |
CommunityList |
Comma separated list of Community Ids (CommId1,CommId2,...) or, Builder Id and Community Id separated by pipes (BuilderId1|CommunityId1,...), depending on:
|
string |
None. |
PlanList |
Plan Ids, splited by ",". Used if lead type is Home (hm). The ParentCommunityId (optional) can be send with it. |
string |
None. |
SpecList |
Specs Ids, splited by ",". Used if lead type is Home (hm). The ParentCommunityId (optional) can be send with it. |
string |
None. |
BuilderId |
Builder Id should be used with lead types: Market (rcm), Rcm (RCM-Return), and you should send the community list parameter. Also the Parent CommunityId (optional) can be sent. |
integer |
None. |
ParentCommunityId |
The specs which has a parent community Id are pointing to the MPC, so if a lead is requested from one of this specs, the charge will be applied to the MPC instead of the community division. |
integer |
None. |
ParentCommunityName |
Name of the parent community. Should be send if the ParentCommunityId is filled. |
string |
None. |
IsActiveAdult |
Saved inside lead info, used to know if the lead is requested from an adult user. NHS gets this information from the profile. |
boolean |
None. |
IsBoyol |
Used to know if the community or spec is a Build on your own lot element. |
boolean |
None. |
RealtorInfo |
Saved inside user preferences. |
string |
None. |
RecoCount |
Community Recommendations count |
integer |
None. |
SourceCommunityId |
Saved inside Lead site info. Used when the lead type is Community |
integer |
None. |
SourcePlanId |
Saved inside Lead site info. Used when the lead type is Home and the plan options are not displayed (NHS) |
integer |
None. |
SourceSpecId |
Saved inside Lead site info. Used when the lead type is Home. Should be sent with the source Plan id. |
integer |
None. |
RequestUniqueKey |
Unique identifier for each lead requested, created using a global unique identifier (GUID) |
string |
None. |
ClientsInfo |
Save inside Lead site information. Used for creating the lead for the builder message. NHS obtains this information from the user profile. |
string |
None. |
SuppressEmail |
Added on site information. It is sent as true when its a Coming Soon Lead. |
boolean |
None. |
IsBilled |
Used to know if the community is billed or unbilled. |
boolean |
None. |
Community |
Api Community object, Community from the lead was requested. |
ApiLeadCommunity |
None. |
Home |
Api Home object, Home from the lead was requested. |
ApiLeadHome |
None. |
IsRecommended |
Used to know if the lead is from a recommended community. |
boolean |
None. |
AgentName |
Sales Agent Name (The isBilled parameter should be sent as true and the agent mail schould be filled) |
string |
None. |
AgentMail |
Sale Agent Email (The isBilled parameter should be sent as true and the agent name schould be filled) |
string |
None. |
Response
Code Generator
Response Information
Name | Description | Type | Additional information |
---|---|---|---|
Time | string |
None. |
|
Error | Exception |
None. |
|
ErrorMessage | string |
None. |
|
Status | string |
None. |
|
Server | string |
None. |
|
Count | integer |
None. |
|
FavoriteCounts | ApiFavoriteCounts |
None. |
|
FavoriteFacets | ApiFavoriteFacets |
None. |
|
Result | string |
None. |
|
VerboseLogger | List of IVerboseLogger |
None. |