Start free trial

Set a firm staff member's sidebar menu

PUT/api/v1/advisory-firms/{firm_id}/users/{user_id}/menu

Restrict which app sections a firm staff member can reach, either firm-wide or for one client business. Firm staff reach clients through the firm and have no membership row there, so the per-membership menu could not be stored for them at all — this is where their menu lives instead. Unlike the per-membership menu, this one is enforced server-side: a request for a section outside the menu is rejected with 403, not merely hidden from the sidebar.

Operation ID: set_firm_staff_menu_api_v1_advisory_firms__firm_id__users__user_id__menu_put·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

firm_idstringrequired
user_idstringrequired

Request body

Schema: FirmStaffMenuRequest

business_idstring

Client business to scope the menu to. Omit or null for the staff member's firm-wide default.

visible_sectionsarray · string

Sidebar section keys this staff member may reach. null clears the menu (all sections); an empty list grants none.

Responses

200Successful Response

Schema: SuccessEnvelope_FirmStaffMenuResponse_

successboolean
messagestring
codestring
dataFirmStaffMenuResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject