latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Offices

Patch office

Patches office fields for the specified office GUID. Supported patch field is name. Returns 422 for invalid patch types, duplicate office names, or if the caller is not a broker.

Validation & Requirements

Required Parameters

  • officeGuid (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.
patch/api/offices/{officeGuid}

Path parameters

officeGuidstring guid required

GUID of the office to patch.

Query parameters

Namestring nullable

Response

warningsstring[] nullable