Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Leads

Update Property Info

Attach a property (or mailing address) to the specified lead. The behaviour depends on the property.id field in the request body:

  • id omitted or <= 0 — the service first tries to merge with an existing property on the lead that has the same street/city/state/zip; if no match is found, a new property record is created.
  • id > 0 — the named property is updated in place. The property must belong to this lead (its leadUserId must match the lead's); otherwise the request is rejected with 200108 LEAD_PROPERTY_NOT_EXIST.

Validation:

  • At least one of city, state, zipCode, streetAddress must be non-blank; otherwise 200057 PROPERTY_ADDRESS_EMPTY is returned.
  • Caller must have manage permission on the lead.
post/v1.0/leads/{leadId}/property

Path parameters

leadIdinteger required

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

priceinteger

The price Applies to lead routing only if the leadType field is Seller(1)

statestring

The state Applies to lead routing only if the leadType field is Seller(1)

citystring

The city Applies to lead routing only if the leadType field is Seller(1)

streetAddressstring

The street address Applies to lead routing only if the leadType field is Seller(1)

zipCodestring

The zip code Applies to lead routing only if the leadType field is Seller(1)

countystring

The county Applies to lead routing only if the leadType field is Seller(1)

propertyTypestring

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

bedroomsinteger

The bed rooms.

bathroomsnumber double

The bath rooms.

squareFeetinteger

The square feet.

lotSizenumber double

The lot size (acreage).

parkingSpaceinteger

The parking space.

floorsinteger

The floors.

mailAddressboolean

If set to true, the address is a mailing address; otherwise, it is a property address.

idinteger

The property ID. Required when updating an existing mailing address or property address. If not provided, a new address will be created.

leadUserIdinteger
listingIdstring
autoListingIdinteger
labelstring
notestring
listingStatusstring
labelListstring
pictureUrlstring
siteListingUrlstring
labelTypestring
priceMaxinteger

The max price Applies to lead routing only if the leadType field is Seller(1)

priceMininteger

The min price Applies to lead routing only if the leadType field is Seller(1)

Example request

{
  "price": 100000,
  "state": "California",
  "city": "New York",
  "streetAddress": "22348 Regnart RD",
  "zipCode": "25401",
  "propertyType": "Single Family Home",
  "bedrooms": 3,
  "bathrooms": 2,
  "squareFeet": 100,
  "lotSize": 26.33,
  "parkingSpace": 1,
  "floors": 1,
  "priceMax": 10000000,
  "priceMin": 100000
}

Response

Property created or updated.

leadIdinteger

ID of the lead.

Example response

{
  "leadId": 651095960136641
}