v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Leads

Add Inquiry

Place an inquiry for a lead.

post/v1.0/leads/{leadId}/inquiry

Path parameters

leadIdinteger required

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

priceMininteger

Price range lower end

priceMaxinteger

Price range higher end

propertyTypestring[]

Property types: Single Family Home, Multi-Family, Condo, Townhouse, Mobile Home, Manufactured Home, Vacant Land, Commercial.

bedroomsMininteger

Bed Rooms

bathroomsMinstring

Bath Rooms

idinteger
leadUserIdinteger
bedroomsMaxinteger
bathroomsMaxstring
modifyByAgentboolean
createTimestring date-time
updateTimestring date-time
defaultValueboolean

Example request

{
  "priceMin": 1,
  "priceMax": 10000000,
  "propertyType": [
    "Single Family Home",
    "Condo"
  ],
  "bedroomsMin": 1,
  "bathroomsMin": "1",
  "locations": [
    {
      "city": "Austin",
      "stateCode": "TX"
    }
  ]
}

Response

Successful operation.

leadIdinteger

ID of the lead.

Example response

{
  "leadId": 651095960136641
}