Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Path Parameters

officeId
string<uuid>
required

Body

application/json

Partial update payload for an office (FBS-3322)

name
object
required

Office name

contactName
object
required

Office contact name

address
object
required

Office address (full replace when present)

active
object
required

Set to false to soft-delete the office. Must be a boolean if present; null is invalid. Reactivation (true) is not supported.

Example:

false

isReactivation
boolean
required
isAtLeastOneModifiableField
boolean
required
isNameValidWhenPresent
boolean
required
isAddressValidWhenPresent
boolean
required
isActiveValidWhenPresent
boolean
required
isReactivationNotRequested
boolean
required
nameField
object
required
contactNameField
object
required
addressField
object
required
activeField
object
required

Response

Office updated

An office location belonging to the organization

id
string<uuid>
required

Unique identifier for this office

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

name
string
required

Display name of the office

Example:

"HQ Office"

address
object
required

Physical address of this office, used for equipment deliveries and returns

active
boolean
required

Whether this office is currently active. Inactive offices cannot receive new orders or returns

Example:

true

contactName
string

Name of the contact person at this office, used for shipping and logistics

Example:

"Jane Doe"