latestOpenAPI 3.0.02026-08-12207455917.9 KB
bad0d2db9b7a
Sale documents
Update document
Patches sale document metadata for the specified document GUID. Supported fields are fileName and folder. folder must be Admin, Trash, or null. Only brokers/auditors can move documents to Admin or out of Admin. File extension changes are rejected. Invalid patch types/values return 422.
Validation & Requirements
Required Parameters
- saleGuid (path, string, format=guid)
- documentGuid (path, string, format=guid)
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.
patch/api/files/sales/{saleGuid}/documents/{documentGuid}
Path parameters
saleGuidstring guid required
GUID of the sale that owns the document.
documentGuidstring guid required
GUID of the document metadata record to update.
Query parameters
FileNamestring nullable
The filename of the document
Folderstring nullable
Can be Admin or Trash or null