latestOpenAPI 3.0.02026-08-12207455917.9 KB
bad0d2db9b7a
Sales
Convert sale to under contract
Converts a pre-contract sale to under-contract status. This endpoint only works when the sale is currently in Pre-Contract status; otherwise it returns 422. Conversion payload validation follows managed-field requirements and includes property/source/date/price rules (for example: required source/otherSource combinations, required contract acceptance or closing fields when configured, acceptance date not in the future, and sale price constraints).
Validation & Requirements
Required Parameters
- saleGuid (path, string, format=guid)
- form (body, object)
Required JSON Body Fields
- agentGuid (format=guid, minLength=1)
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}/convert/under-contract
Path parameters
saleGuidstring guid required
GUID of the sale you want to convert to under contract.