latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Sale Properties

Update property

Updates sale property details for the specified sale. streetNumber, streetAddress, city, state, and zip are required. Returns 422 for invalid property values (including managed-field requirements such as year built), duplicate property/checklist combinations, or invalid commercial-lease values when applicable.

Validation & Requirements

Required Parameters

  • saleGuid (path, string, format=guid)
  • form (body, object)

Required JSON Body Fields

  • streetNumber (minLength=1)
  • streetAddress (minLength=1)
  • city (minLength=1)
  • state (minLength=1)
  • zip (minLength=1)
  • yearBuilt (format=int32)

Validations

  • Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
  • Invalid date values in *date* fields return 422 Unprocessable Entity.
  • Missing required request body returns 422 Unprocessable Entity with Missing request body..
  • Additional business-rule validation may return 422 with details in the errors array.

Integration Requirement

  • Retrieve the corresponding ...Form endpoint immediately before write operations to get current dynamic required fields and allowed values.
put/api/files/sales/{saleGuid}/property

Path parameters

saleGuidstring guid required

GUID of the sale whose property details you want to update.

Request body

streetNumberstring required
streetAddressstring required
unitstring nullable
directionstring nullable
citystring required
countystring nullable
statestring required
zipstring required
yearBuiltinteger required
realPropertyTypeIdinteger nullable
realPropertySubtypeIdinteger nullable

Response

valueUpdateSalePropertyResponse
warningsstring[] nullable