Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Lead Transaction

Update Property Address

Updates the property address of a transaction. The transactionId is carried in the request body, not the URL.

Full replacement — omitted fields are set to null. To update a single field, GET the current address first, modify, then resubmit the whole object.

post/v1.0/leads/{leadId}/transaction/property/address

Path parameters

leadIdinteger required

Lead ID. Must be manageable by the caller.

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

transactionIdinteger required

Transaction ID whose property address is being queried or updated. Required on the update endpoint (carried in the request body, not the URL).

unitstring

Unit / apartment number.

labelstring

Free-form label for the address (e.g. 'Investment', 'Primary Residence').

statestring

State or province code.

citystring

City.

zipCodestring

Postal / ZIP code.

streetAddressstring

Street address.

countystring

County.

Example request

{
  "transactionId": 10001,
  "unit": "1",
  "label": "Investment",
  "state": "CA",
  "city": "Los Angeles",
  "zipCode": "90012",
  "streetAddress": "100 W 1st St",
  "county": "Los Angeles"
}

Response

Envelope {code, message}. code=0 indicates success.

codeinteger

Business result code. 0 indicates success; non-zero values indicate a business failure (e.g. 200060 TRANSACTION_NOT_EXIST).

messagestring

Human-readable message that accompanies the code.

Example response

{
  "message": "success"
}