POST api/CreateLead
Request Information
URI Parameters
None.
Body Parameters
CreateLeadVm| Name | Description | Type | Additional information |
|---|---|---|---|
| SourceId | integer |
None. |
|
| SubSourceId | integer |
None. |
|
| LeadCategoryId | integer |
None. |
|
| CompanyStageReasonId | integer |
None. |
|
| Type | string |
None. |
|
| ClientName | string |
None. |
|
| FirstName | string |
None. |
|
| AlternateNumbers | string |
None. |
|
| LastName | string |
None. |
|
| ClientContactCC | string |
None. |
|
| ClientContact | string |
None. |
|
| SecondaryNumberCC | string |
None. |
|
| SecondaryNumber | string |
None. |
|
| ClientEmail | string |
None. |
|
| BrokerName | string |
None. |
|
| BrokerInvolved | boolean |
None. |
|
| BrokerContact | string |
None. |
|
| CompanyStageId | integer |
None. |
|
| RequirementId | integer |
None. |
|
| CarpetArea | decimal number |
None. |
|
| Budget | decimal number |
None. |
|
| LeadRemark | string |
None. |
|
| Remark | string |
None. |
|
| Date | string |
None. |
|
| LeadDate | date |
None. |
|
| LeadTypeId | integer |
None. |
|
| CompanyContactTypeId | integer |
None. |
|
| LeadSubTypeId | integer |
None. |
|
| Problem | string |
None. |
|
| IsPropertyShown | boolean |
None. |
|
| IsPropertyShortlisted | boolean |
None. |
|
| IsInvestor | boolean |
None. |
|
| IsForRent | boolean |
None. |
|
| IsForSale | boolean |
None. |
|
| IsFurnished | boolean |
None. |
|
| Deposit | decimal number |
None. |
|
| IsLumsum | boolean |
None. |
|
| SaleAmount | decimal number |
None. |
|
| Area | decimal number |
None. |
|
| IsLoan | boolean |
None. |
|
| LoanBank | string |
None. |
|
| LoanAmount | decimal number |
None. |
|
| LoanInterest | decimal number |
None. |
|
| LoanPeriod | decimal number |
None. |
|
| Terms | string |
None. |
|
| DateOfBirth | string |
None. |
|
| DateOfAnniversary | string |
None. |
|
| BudgetMin | decimal number |
None. |
|
| BudgetMax | decimal number |
None. |
|
| AreaMin | decimal number |
None. |
|
| AreaMax | decimal number |
None. |
|
| UserId | integer |
None. |
|
| SourceManagerId | integer |
None. |
|
| UserIds | Collection of integer |
None. |
|
| ProjectId | integer |
None. |
|
| UnitId | integer |
None. |
|
| AllowedForId | integer |
None. |
|
| StateId | integer |
None. |
|
| LocationId | integer |
None. |
|
| ContactId | integer |
None. |
|
| Furnish | string |
None. |
|
| MembershipType | string |
None. |
|
| UnitTypes | Collection of GetAllMasterVm |
None. |
|
| LeadPropertySubTypes | Collection of KeyValuePairVm |
None. |
|
| Projects | Collection of integer |
None. |
|
| LeadStageId | integer |
None. |
|
| OutcomeId | integer |
None. |
|
| FollowUpDate | string |
None. |
|
| NextFollowUpAgenda | string |
None. |
|
| FollowUpRemark | string |
None. |
|
| IsIvrLead | boolean |
None. |
|
| IvrId | integer |
None. |
|
| Address | string |
None. |
|
| Lat | decimal number |
None. |
|
| Lng | decimal number |
None. |
|
| Country | string |
None. |
|
| State | string |
None. |
|
| District | string |
None. |
|
| Location | string |
None. |
|
| SubLocation | string |
None. |
|
| InventoryLocationArea | string |
None. |
|
| Pincode | string |
None. |
|
| EmploymentType | string |
None. |
|
| Income | decimal number |
None. |
|
| Designation | string |
None. |
|
| CompanyName | string |
None. |
|
| CompanyPropertyTypeId | integer |
None. |
|
| AreaMetricId | integer |
None. |
|
| LeadAddress | string |
None. |
|
| LeadCity | string |
None. |
|
| LeadState | string |
None. |
|
| LeadCountry | string |
None. |
|
| LeadZipcode | string |
None. |
|
| ChannelPartnerId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"SourceId": 1,
"SubSourceId": 1,
"LeadCategoryId": 1,
"CompanyStageReasonId": 1,
"Type": "sample string 2",
"ClientName": "sample string 3",
"FirstName": "sample string 4",
"AlternateNumbers": "sample string 5",
"LastName": "sample string 6",
"ClientContactCC": "sample string 7",
"ClientContact": "sample string 8",
"SecondaryNumberCC": "sample string 9",
"SecondaryNumber": "sample string 10",
"ClientEmail": "sample string 11",
"BrokerName": "sample string 12",
"BrokerInvolved": true,
"BrokerContact": "sample string 14",
"CompanyStageId": 15,
"RequirementId": 16,
"CarpetArea": 17.1,
"Budget": 18.1,
"LeadRemark": "sample string 19",
"Remark": "sample string 20",
"Date": "sample string 21",
"LeadDate": "2025-12-07T14:36:05.2433886Z",
"LeadTypeId": 23,
"CompanyContactTypeId": 1,
"LeadSubTypeId": 1,
"Problem": "sample string 24",
"IsPropertyShown": true,
"IsPropertyShortlisted": true,
"IsInvestor": true,
"IsForRent": true,
"IsForSale": true,
"IsFurnished": true,
"Deposit": 31.1,
"IsLumsum": true,
"SaleAmount": 33.1,
"Area": 34.1,
"IsLoan": true,
"LoanBank": "sample string 36",
"LoanAmount": 37.1,
"LoanInterest": 38.1,
"LoanPeriod": 39.1,
"Terms": "sample string 40",
"DateOfBirth": "sample string 41",
"DateOfAnniversary": "sample string 42",
"BudgetMin": 43.1,
"BudgetMax": 44.1,
"AreaMin": 45.1,
"AreaMax": 46.1,
"UserId": 1,
"SourceManagerId": 1,
"UserIds": [
1,
2
],
"ProjectId": 1,
"UnitId": 1,
"AllowedForId": 1,
"StateId": 1,
"LocationId": 1,
"ContactId": 1,
"Furnish": "sample string 47",
"MembershipType": "sample string 48",
"UnitTypes": [
{
"Id": 1,
"Name": "sample string 2",
"Code": "sample string 3",
"ProjectTypeId": 1,
"CompanyUnitTypeId": 1,
"ProjectType": "sample string 4",
"CompanyUnitType": "sample string 5"
},
{
"Id": 1,
"Name": "sample string 2",
"Code": "sample string 3",
"ProjectTypeId": 1,
"CompanyUnitTypeId": 1,
"ProjectType": "sample string 4",
"CompanyUnitType": "sample string 5"
}
],
"LeadPropertySubTypes": [
{
"Id": 1,
"Name": "sample string 1",
"Code": "sample string 2",
"Order": 3
},
{
"Id": 1,
"Name": "sample string 1",
"Code": "sample string 2",
"Order": 3
}
],
"Projects": [
1,
2
],
"LeadStageId": 49,
"OutcomeId": 50,
"FollowUpDate": "sample string 51",
"NextFollowUpAgenda": "sample string 52",
"FollowUpRemark": "sample string 53",
"IsIvrLead": true,
"IvrId": 1,
"Address": "sample string 55",
"Lat": 56.1,
"Lng": 57.1,
"Country": "sample string 58",
"State": "sample string 59",
"District": "sample string 60",
"Location": "sample string 61",
"SubLocation": "sample string 62",
"InventoryLocationArea": "sample string 63",
"Pincode": "sample string 64",
"EmploymentType": "sample string 65",
"Income": 66.1,
"Designation": "sample string 67",
"CompanyName": "sample string 68",
"CompanyPropertyTypeId": 1,
"AreaMetricId": 1,
"LeadAddress": "sample string 69",
"LeadCity": "sample string 70",
"LeadState": "sample string 71",
"LeadCountry": "sample string 72",
"LeadZipcode": "sample string 73",
"ChannelPartnerId": 1
}
application/xml, text/xml
Sample:
<CreateLeadVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services.Lead">
<Address>sample string 55</Address>
<AllowedForId>1</AllowedForId>
<AlternateNumbers>sample string 5</AlternateNumbers>
<Area>34.1</Area>
<AreaMax>46.1</AreaMax>
<AreaMetricId>1</AreaMetricId>
<AreaMin>45.1</AreaMin>
<BrokerContact>sample string 14</BrokerContact>
<BrokerInvolved>true</BrokerInvolved>
<BrokerName>sample string 12</BrokerName>
<Budget>18.1</Budget>
<BudgetMax>44.1</BudgetMax>
<BudgetMin>43.1</BudgetMin>
<CarpetArea>17.1</CarpetArea>
<ChannelPartnerId>1</ChannelPartnerId>
<ClientContact>sample string 8</ClientContact>
<ClientContactCC>sample string 7</ClientContactCC>
<ClientEmail>sample string 11</ClientEmail>
<ClientName>sample string 3</ClientName>
<CompanyContactTypeId>1</CompanyContactTypeId>
<CompanyName>sample string 68</CompanyName>
<CompanyPropertyTypeId>1</CompanyPropertyTypeId>
<CompanyStageId>15</CompanyStageId>
<CompanyStageReasonId>1</CompanyStageReasonId>
<ContactId>1</ContactId>
<Country>sample string 58</Country>
<Date>sample string 21</Date>
<DateOfAnniversary>sample string 42</DateOfAnniversary>
<DateOfBirth>sample string 41</DateOfBirth>
<Deposit>31.1</Deposit>
<Designation>sample string 67</Designation>
<District>sample string 60</District>
<EmploymentType>sample string 65</EmploymentType>
<FirstName>sample string 4</FirstName>
<FollowUpDate>sample string 51</FollowUpDate>
<FollowUpRemark>sample string 53</FollowUpRemark>
<Furnish>sample string 47</Furnish>
<Income>66.1</Income>
<InventoryLocationArea>sample string 63</InventoryLocationArea>
<IsForRent>true</IsForRent>
<IsForSale>true</IsForSale>
<IsFurnished>true</IsFurnished>
<IsInvestor>true</IsInvestor>
<IsIvrLead>true</IsIvrLead>
<IsLoan>true</IsLoan>
<IsLumsum>true</IsLumsum>
<IsPropertyShortlisted>true</IsPropertyShortlisted>
<IsPropertyShown>true</IsPropertyShown>
<IvrId>1</IvrId>
<LastName>sample string 6</LastName>
<Lat>56.1</Lat>
<LeadAddress>sample string 69</LeadAddress>
<LeadCategoryId>1</LeadCategoryId>
<LeadCity>sample string 70</LeadCity>
<LeadCountry>sample string 72</LeadCountry>
<LeadDate>2025-12-07T20:06:05.2433886+05:30</LeadDate>
<LeadPropertySubTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
<d2p1:KeyValuePairVm>
<d2p1:Code>sample string 2</d2p1:Code>
<d2p1:Id>1</d2p1:Id>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Order>3</d2p1:Order>
</d2p1:KeyValuePairVm>
<d2p1:KeyValuePairVm>
<d2p1:Code>sample string 2</d2p1:Code>
<d2p1:Id>1</d2p1:Id>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Order>3</d2p1:Order>
</d2p1:KeyValuePairVm>
</LeadPropertySubTypes>
<LeadRemark>sample string 19</LeadRemark>
<LeadStageId>49</LeadStageId>
<LeadState>sample string 71</LeadState>
<LeadSubTypeId>1</LeadSubTypeId>
<LeadTypeId>23</LeadTypeId>
<LeadZipcode>sample string 73</LeadZipcode>
<Lng>57.1</Lng>
<LoanAmount>37.1</LoanAmount>
<LoanBank>sample string 36</LoanBank>
<LoanInterest>38.1</LoanInterest>
<LoanPeriod>39.1</LoanPeriod>
<Location>sample string 61</Location>
<LocationId>1</LocationId>
<MembershipType>sample string 48</MembershipType>
<NextFollowUpAgenda>sample string 52</NextFollowUpAgenda>
<OutcomeId>50</OutcomeId>
<Pincode>sample string 64</Pincode>
<Problem>sample string 24</Problem>
<ProjectId>1</ProjectId>
<Projects xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</Projects>
<Remark>sample string 20</Remark>
<RequirementId>16</RequirementId>
<SaleAmount>33.1</SaleAmount>
<SecondaryNumber>sample string 10</SecondaryNumber>
<SecondaryNumberCC>sample string 9</SecondaryNumberCC>
<SourceId>1</SourceId>
<SourceManagerId>1</SourceManagerId>
<State>sample string 59</State>
<StateId>1</StateId>
<SubLocation>sample string 62</SubLocation>
<SubSourceId>1</SubSourceId>
<Terms>sample string 40</Terms>
<Type>sample string 2</Type>
<UnitId>1</UnitId>
<UnitTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/BrokerServer.Services">
<d2p1:GetAllMasterVm>
<d2p1:Code>sample string 3</d2p1:Code>
<d2p1:CompanyUnitType>sample string 5</d2p1:CompanyUnitType>
<d2p1:CompanyUnitTypeId>1</d2p1:CompanyUnitTypeId>
<d2p1:Id>1</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:ProjectType>sample string 4</d2p1:ProjectType>
<d2p1:ProjectTypeId>1</d2p1:ProjectTypeId>
</d2p1:GetAllMasterVm>
<d2p1:GetAllMasterVm>
<d2p1:Code>sample string 3</d2p1:Code>
<d2p1:CompanyUnitType>sample string 5</d2p1:CompanyUnitType>
<d2p1:CompanyUnitTypeId>1</d2p1:CompanyUnitTypeId>
<d2p1:Id>1</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:ProjectType>sample string 4</d2p1:ProjectType>
<d2p1:ProjectTypeId>1</d2p1:ProjectTypeId>
</d2p1:GetAllMasterVm>
</UnitTypes>
<UserId>1</UserId>
<UserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</UserIds>
</CreateLeadVm>
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>