latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Offices

Update office

Replaces office details for the specified office GUID. Returns 422 when user/subscriber is invalid, caller is not a broker-level user, or office name already exists.

Validation & Requirements

Required Parameters

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

Required JSON Body Fields

  • officeName (minLength=1, maxLength=30)

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.
put/api/offices/{officeGuid}

Path parameters

officeGuidstring guid required

GUID of the office to update.

Request body

officeNamestring required
officeEmailstring email nullable
isInboxEnabledboolean
timeZoneIdstring nullable
isUserAllowedtoChangeTimeZoneboolean
isTransactionLenderContactRequiredboolean
isClientEmailAddressRequiredboolean
ppOfficeGUIDstring nullable

Response

warningsstring[] nullable