POST api/inboundlead/create?assignToNegId={assignToNegId}
Creates a lead in the system, optinally assigning the lead to a negotiator
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assignToNegId |
Negotiator Id to assign lead too |
integer |
None. |
Body Parameters
Dezrez.Core.DataContracts.External.Api.InboundLeads.InboundLeadDataContractName | Description | Type | Additional information |
---|---|---|---|
BranchId | integer |
None. |
|
People | Collection of Dezrez.Core.DataContracts.External.Api.InboundLeads.LeadPersonDataContract |
None. |
|
string |
None. |
||
DateSubmitted | date |
None. |
|
Address | string |
None. |
|
Postcode | string |
None. |
|
Country | string |
None. |
|
PhonePrimary | string |
None. |
|
PhoneMobile | string |
None. |
|
PhoneOther | string |
None. |
|
DPAFlag | boolean |
None. |
|
PropertyToSell | boolean |
None. |
|
PropertyToRent | boolean |
None. |
|
Comment | string |
None. |
|
FinancialAdvice | boolean |
None. |
|
PartExchange | boolean |
None. |
|
SourceType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
RequestType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
PropertyMarketingRoleIds | Collection of integer |
None. |
|
PropertyDetails | Collection of Dezrez.Core.DataContracts.External.Api.InboundLeads.LeadPropertyDetailDataContract |
None. |
|
Id | integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{ "BranchId": 1, "People": [ { "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3" }, { "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3" } ], "Email": "sample string 1", "DateSubmitted": "2024-11-14T07:13:47.4696645Z", "Address": "sample string 3", "Postcode": "sample string 4", "Country": "sample string 5", "PhonePrimary": "sample string 6", "PhoneMobile": "sample string 7", "PhoneOther": "sample string 8", "DPAFlag": true, "PropertyToSell": true, "PropertyToRent": true, "Comment": "sample string 9", "FinancialAdvice": true, "PartExchange": true, "SourceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "RequestType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PropertyMarketingRoleIds": [ 1, 2 ], "PropertyDetails": [ { "PropertyId": 1, "Price": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "RoleStatus": "sample string 2", "UnderOffer": true, "OrganizationName": "sample string 4", "Number": "sample string 5", "BuildingName": "sample string 6", "Street": "sample string 7", "Town": "sample string 8", "Locality": "sample string 9", "County": "sample string 10", "Postcode": "sample string 11", "Id": 12 }, { "PropertyId": 1, "Price": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "RoleStatus": "sample string 2", "UnderOffer": true, "OrganizationName": "sample string 4", "Number": "sample string 5", "BuildingName": "sample string 6", "Street": "sample string 7", "Town": "sample string 8", "Locality": "sample string 9", "County": "sample string 10", "Postcode": "sample string 11", "Id": 12 } ], "Id": 10 }
Response Information
Resource Description
Dezrez.Core.DataContracts.External.Api.InboundLeads.InboundLeadDataContractName | Description | Type | Additional information |
---|---|---|---|
BranchId | integer |
None. |
|
People | Collection of Dezrez.Core.DataContracts.External.Api.InboundLeads.LeadPersonDataContract |
None. |
|
string |
None. |
||
DateSubmitted | date |
None. |
|
Address | string |
None. |
|
Postcode | string |
None. |
|
Country | string |
None. |
|
PhonePrimary | string |
None. |
|
PhoneMobile | string |
None. |
|
PhoneOther | string |
None. |
|
DPAFlag | boolean |
None. |
|
PropertyToSell | boolean |
None. |
|
PropertyToRent | boolean |
None. |
|
Comment | string |
None. |
|
FinancialAdvice | boolean |
None. |
|
PartExchange | boolean |
None. |
|
SourceType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
RequestType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
PropertyMarketingRoleIds | Collection of integer |
None. |
|
PropertyDetails | Collection of Dezrez.Core.DataContracts.External.Api.InboundLeads.LeadPropertyDetailDataContract |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "BranchId": 1, "People": [ { "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3" }, { "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3" } ], "Email": "sample string 1", "DateSubmitted": "2024-11-14T07:13:47.4852903Z", "Address": "sample string 3", "Postcode": "sample string 4", "Country": "sample string 5", "PhonePrimary": "sample string 6", "PhoneMobile": "sample string 7", "PhoneOther": "sample string 8", "DPAFlag": true, "PropertyToSell": true, "PropertyToRent": true, "Comment": "sample string 9", "FinancialAdvice": true, "PartExchange": true, "SourceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "RequestType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PropertyMarketingRoleIds": [ 1, 2 ], "PropertyDetails": [ { "PropertyId": 1, "Price": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "RoleStatus": "sample string 2", "UnderOffer": true, "OrganizationName": "sample string 4", "Number": "sample string 5", "BuildingName": "sample string 6", "Street": "sample string 7", "Town": "sample string 8", "Locality": "sample string 9", "County": "sample string 10", "Postcode": "sample string 11", "Id": 12 }, { "PropertyId": 1, "Price": { "PriceValue": 1.1, "CurrencyCode": "sample string 2", "PriceText": "sample string 3", "PriceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceQualifierType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 4 }, "RoleStatus": "sample string 2", "UnderOffer": true, "OrganizationName": "sample string 4", "Number": "sample string 5", "BuildingName": "sample string 6", "Street": "sample string 7", "Town": "sample string 8", "Locality": "sample string 9", "County": "sample string 10", "Postcode": "sample string 11", "Id": 12 } ], "Id": 10 }