Skip to main content

Update Workspace Menu Override (v1)

Update workspace menu allowed sections.

Method & Path​

PUT /v1/admin/workspace-menus/:workspaceId/menus

Description​

Creates or updates the menu override for a workspace, specifying which dashboard sections are allowed to be visible.

Authentication​

Required: Admin authentication with businesses.manage permission.

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesThe workspace ID

Request Body​

{
  "allowedMenuSections": [
    "overview",
    "sessions",
    "clients",
    "storefront",
    "settings"
  ]
}

Allowed Menu Sections​

  • overview
  • team-board
  • staff-directory
  • clients
  • sessions
  • storefront
  • vcard
  • labs
  • payments-expenses
  • sms-tracking
  • ai-tracking
  • storage-tracking
  • settings
  • referrals

Response 200 OK​

{
  "override": {
    "workspaceId": "507f1f77bcf86cd799439011",
    "allowedMenuSections": [
      "overview",
      "sessions",
      "clients",
      "storefront",
      "settings"
    ]
  }
}

Common Errors​

  • 401 Unauthorized: Missing or invalid admin authentication token
  • 403 Forbidden: Insufficient permissions
  • 400 Bad Request: Invalid request body or invalid menu sections
  • 500 Internal Server Error: Server error