Sign in
Sales

Update sale

Updates sale-level fields for the specified sale.

Validation & Requirements

Required Parameters

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

Required JSON Body Fields

  • None

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}

Path parameters

saleGuidstring guid required

GUID of the sale to update. Format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Request body

mlsNumberstring nullable
contractAcceptanceDatestring date-time nullable
escrowNumberstring nullable
escrowClosingDatestring date-time nullable
actualClosingDatestring date-time nullable

Setting this field closes the sale (status → Closed) and records the closing date. Prefer the dedicated PUT /api/files/sales/{saleGuid}/close endpoint for an explicit close action.

sourceIdinteger nullable

SourceId can be retrieved from the AllowableSelections list.

otherSourcestring nullable

Required only for certain SourceId fields

listingPricenumber nullable
salePricenumber nullable
isOfficeLeadboolean nullable
fileIdstring nullable
apnstring nullable
realPropertyTypeIdinteger nullable
realPropertySubtypeIdinteger nullable

Response

valueUpdateSaleResponse
warningsstring[] nullable