POST api/buildeskapi/lead/create
Request Information
URI Parameters
None.
Body Parameters
WebhookPostVm| Name | Description | Type | Additional information |
|---|---|---|---|
| CreateDate | date |
None. |
|
| EventId | integer |
None. |
|
| ApiKey | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| DialCode | string |
None. |
|
| Mobile | string |
None. |
|
| SecondaryNumber | string |
None. |
|
| CreatedDate | string |
None. |
|
| string |
None. |
||
| Remark | string |
None. |
|
| Remark1 | string |
None. |
|
| CampaignName | string |
None. |
|
| Source | string |
None. |
|
| SubSource | string |
None. |
|
| PropertyType | string |
None. |
|
| LeadCategory | string |
None. |
|
| UID | string |
None. |
|
| ProjectUID | string |
None. |
|
| ProjectName | string |
None. |
|
| UserId | integer |
None. |
|
| HasVisit | boolean |
None. |
|
| LeadStageChange | boolean |
None. |
|
| VisitDate | string |
None. |
|
| PrimarySource | integer |
None. |
|
| City | string |
None. |
|
| MinBudget | decimal number |
None. |
|
| MaxBudget | decimal number |
None. |
|
| EmploymentType | string |
None. |
|
| IsLoan | boolean |
None. |
|
| Income | decimal number |
None. |
|
| Designation | string |
None. |
|
| CompanyName | string |
None. |
|
| Address | string |
None. |
|
| Ethnicity | string |
None. |
|
| UtmCampaign | string |
None. |
|
| UtmMedium | string |
None. |
|
| UtmSource | string |
None. |
|
| UtmTerm | string |
None. |
|
| GCLId | string |
None. |
|
| FbId | string |
None. |
|
| UtmContent | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CreateDate": "2026-05-21T13:24:51.3853035Z",
"EventId": 2,
"ApiKey": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"DialCode": "sample string 6",
"Mobile": "sample string 7",
"SecondaryNumber": "sample string 8",
"CreatedDate": "sample string 9",
"Email": "sample string 10",
"Remark": "sample string 11",
"Remark1": "sample string 12",
"CampaignName": "sample string 13",
"Source": "sample string 14",
"SubSource": "sample string 15",
"PropertyType": "sample string 16",
"LeadCategory": "sample string 17",
"UID": "sample string 18",
"ProjectUID": "sample string 19",
"ProjectName": "sample string 20",
"UserId": 1,
"HasVisit": true,
"LeadStageChange": true,
"VisitDate": "sample string 23",
"PrimarySource": 24,
"City": "sample string 25",
"MinBudget": 26.1,
"MaxBudget": 27.1,
"EmploymentType": "sample string 28",
"IsLoan": true,
"Income": 30.1,
"Designation": "sample string 31",
"CompanyName": "sample string 32",
"Address": "sample string 33",
"Ethnicity": "sample string 34",
"UtmCampaign": "sample string 35",
"UtmMedium": "sample string 36",
"UtmSource": "sample string 37",
"UtmTerm": "sample string 38",
"GCLId": "sample string 39",
"FbId": "sample string 40",
"UtmContent": "sample string 41"
}
application/xml, text/xml
Sample:
<WebhookPostVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services.Lead"> <Address>sample string 33</Address> <ApiKey>sample string 3</ApiKey> <CampaignName>sample string 13</CampaignName> <City>sample string 25</City> <CompanyName>sample string 32</CompanyName> <CreateDate>2026-05-21T13:24:51.3853035+00:00</CreateDate> <CreatedDate>sample string 9</CreatedDate> <Designation>sample string 31</Designation> <DialCode>sample string 6</DialCode> <Email>sample string 10</Email> <EmploymentType>sample string 28</EmploymentType> <Ethnicity>sample string 34</Ethnicity> <EventId>2</EventId> <FbId>sample string 40</FbId> <FirstName>sample string 4</FirstName> <GCLId>sample string 39</GCLId> <HasVisit>true</HasVisit> <Income>30.1</Income> <IsLoan>true</IsLoan> <LastName>sample string 5</LastName> <LeadCategory>sample string 17</LeadCategory> <LeadStageChange>true</LeadStageChange> <MaxBudget>27.1</MaxBudget> <MinBudget>26.1</MinBudget> <Mobile>sample string 7</Mobile> <PrimarySource>24</PrimarySource> <ProjectName>sample string 20</ProjectName> <ProjectUID>sample string 19</ProjectUID> <PropertyType>sample string 16</PropertyType> <Remark>sample string 11</Remark> <Remark1>sample string 12</Remark1> <SecondaryNumber>sample string 8</SecondaryNumber> <Source>sample string 14</Source> <SubSource>sample string 15</SubSource> <UID>sample string 18</UID> <UserId>1</UserId> <UtmCampaign>sample string 35</UtmCampaign> <UtmContent>sample string 41</UtmContent> <UtmMedium>sample string 36</UtmMedium> <UtmSource>sample string 37</UtmSource> <UtmTerm>sample string 38</UtmTerm> <VisitDate>sample string 23</VisitDate> </WebhookPostVm>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Response| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| Description | string |
None. |
|
| Data | Object |
None. |
|
| Count | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Message": "sample string 2",
"Description": "sample string 3",
"Data": {},
"Count": 5
}
application/xml, text/xml
Sample:
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models"> <Count>5</Count> <Data /> <Description>sample string 3</Description> <Message>sample string 2</Message> <Success>true</Success> </Response>