Sale Offices

Update office

Updates the office assignment for the specified sale. This endpoint is for multi-office subscribers; single-office users receive 422. officeGuid must be a known office for the subscriber, the acting user and agent must be allowed to assign that office, and the sale checklist type must belong to the target office.

Validation & Requirements

Required Parameters

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

Required JSON Body Fields

  • officeGuid (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}/office

Path parameters

saleGuidstring guid required

GUID of the sale whose office assignment you want to update.

Request body

officeGuidstring guid required

Response

valueUpdateSaleOfficeResponse
warningsstring[] nullable