This action may lead to changes in the database

Do you want to continue?

Data Explorer

Lead Information

ApiLead

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

ApiLead
Name 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.
hm: Home
com: Community
acc: AccountCreation
rcb: Builder
qc: QuickConnect
rcm: Market
rcc: Campaign
test: Test
pwd: PasswordRecovery
rcm-return: Rcm
art: Article
ebook: EBook
bld: BuilderLead
box: BoxCampaign
boy: Boyl
cmp: LeadCampaign
reg: Registration

string

Required

LeadAction

Defines the lead action, that can be applied
ra: RequestApointment
ri: RequestInfo
cb: ContactBuilder
fb: FreeBrochure
fbxp: FreeBrochureXp
cdra: CommRequestApointment
hmra: HomeRequestApointment
rp: RequestPromotion
emfb: EmailFreeBrochure
qmi: QuickMoveIn
hh: HotHome
qconn: QuickConnect
reco: Recommended
hovfb: HovFreeBrochure
hovra: HovRequestApointment
hovrp: HovRequestPromotion
hovqmi: HovQuickMoveIn
cari: CaRequestInfo
cacb: CaContactBuilder
cafb: CaFreeBrochure
cara: CaRequestApointment
carp: CaRequestPromotion
carbi: CaRequestBuilderInfo
caqmi: CaQuickMoveIn
cahh: CaHotHome
caaq: CaAskQuestion
srcalrt: SearchAlert
fb-sim: FreeBrochureSimpleModal
fb-ru: FreeBrochureReturningUser
recoru: RecommendedReturningUser
recomodal: RecommendedModal
reonpage: RecommendedOnPage
recsimmod: RecommendedSimpleModal
recsimdir: RecommendedSimpleModalDirect
rectypage: RecommendedThankYouPage
tyl: ThankYouLead
agcom: AgentCompensation

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:

      
  • When LeadType is either Comm or RCM-Return and BuilderId property is provided: 'CommunityList' expects a list of Comm Ids split by ","
  •   
  • When LeadType is either Comm or RCM-Return and LeadAction is QCONN (Quick Connect), 'CommunityList' expects a list of Builder Ids and Comm Ids split by split by "|" and  ",". An optional comment could be send, like this: BuilderId|CommId or BuilderId|CommId|Comment
  •   
  • When LeadType is Rcm, 'CommunityList' expects a list of Builder Ids and Comm Ids split by "|" and  ",". An optional comment could be send, like this: BuilderId|CommId or BuilderId|CommId|Comment
  •   
  • Otherwise 'CommunityList' expects a list of Comm Ids split by ","

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.
This optinal parameter will be used on Community, Rcm and Home lead types, It could be send with communities, plans and specs lists.

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

× The request was made Successfully! Check the result!.
× Error Something happen, the Api doesn't have a response.
{ "Time": "sample string 1", "Error": { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null }, "ErrorMessage": "sample string 2", "Status": "sample string 3", "Server": "sample string 4", "Count": 1, "FavoriteCounts": { "CommCount": 1, "PlanCount": 2, "SpecCount": 3 }, "FavoriteFacets": { "Cities": [ { "MarketId": 1, "Count": 1, "Distance": 1.1, "Key": 2, "Value": "sample string 3", "State": "sample string 4" }, { "MarketId": 1, "Count": 1, "Distance": 1.1, "Key": 2, "Value": "sample string 3", "State": "sample string 4" } ], "PostalCodes": [ { "MarketId": 1, "Count": 1, "Distance": 1.1, "Key": 2, "Value": "sample string 3", "State": "sample string 4" }, { "MarketId": 1, "Count": 1, "Distance": 1.1, "Key": 2, "Value": "sample string 3", "State": "sample string 4" } ], "Markets": [ { "MarketId": 1, "Count": 1, "Distance": 1.1, "Key": 2, "Value": "sample string 3", "State": "sample string 4" }, { "MarketId": 1, "Count": 1, "Distance": 1.1, "Key": 2, "Value": "sample string 3", "State": "sample string 4" } ] }, "Result": "sample string 5" }
<Root> <Time>sample string 1</Time> <Error> <ClassName>System.Exception</ClassName> <Message /> <Data /> <InnerException /> <HelpURL>sample string 1</HelpURL> <StackTraceString /> <RemoteStackTraceString /> <RemoteStackIndex>0</RemoteStackIndex> <ExceptionMethod /> <HResult>3</HResult> <Source>sample string 2</Source> <WatsonBuckets /> </Error> <ErrorMessage>sample string 2</ErrorMessage> <Status>sample string 3</Status> <Server>sample string 4</Server> <Count>1</Count> <FavoriteCounts> <CommCount>1</CommCount> <PlanCount>2</PlanCount> <SpecCount>3</SpecCount> </FavoriteCounts> <FavoriteFacets> <Cities> <MarketId>1</MarketId> <Count>1</Count> <Distance>1.1</Distance> <Key>2</Key> <Value>sample string 3</Value> <State>sample string 4</State> </Cities> <Cities> <MarketId>1</MarketId> <Count>1</Count> <Distance>1.1</Distance> <Key>2</Key> <Value>sample string 3</Value> <State>sample string 4</State> </Cities> <PostalCodes> <MarketId>1</MarketId> <Count>1</Count> <Distance>1.1</Distance> <Key>2</Key> <Value>sample string 3</Value> <State>sample string 4</State> </PostalCodes> <PostalCodes> <MarketId>1</MarketId> <Count>1</Count> <Distance>1.1</Distance> <Key>2</Key> <Value>sample string 3</Value> <State>sample string 4</State> </PostalCodes> <Markets> <MarketId>1</MarketId> <Count>1</Count> <Distance>1.1</Distance> <Key>2</Key> <Value>sample string 3</Value> <State>sample string 4</State> </Markets> <Markets> <MarketId>1</MarketId> <Count>1</Count> <Distance>1.1</Distance> <Key>2</Key> <Value>sample string 3</Value> <State>sample string 4</State> </Markets> </FavoriteFacets> <Result>sample string 5</Result> </Root>
Download File

Code Generator

Response Information

ApiResultModelOfString
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.