Update Custom Menu Link

PUT 
/custom-menus/:customMenuId

Updates an existing custom menu for a given company. Requires authentication and proper permissions.

Request

Version stringrequired

API Version

Available optionsv3

customMenuId stringrequired

ID of the custom menu to update

application/json

application/json

Body

Bodyrequired

titlestring

Title of the custom menu

urlstring

URL of the custom menu

iconobject

Icon information for the custom menu

showOnCompanyboolean
Whether the menu must be displayed on the agency's level
Default value: true
showOnLocationboolean
Whether the menu must be displayed for sub-accounts level
Default value: true
showToAllLocationsboolean
Whether the menu must be displayed to all sub-accounts
Default value: true
openModestring
Mode for opening the menu link
Available optionsiframenew_tabcurrent_tab
locationsstring[]

List of sub-account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false

userRolestring
Which user-roles should the menu be accessible to?
Available optionsalladminuser
allowCameraboolean

Whether to allow camera access (only for iframe mode)

allowMicrophoneboolean

Whether to allow microphone access (only for iframe mode)

Example (auto)

{
  "title": "Custom Menu",
  "url": "https://custom-menus.com/",
  "icon": {
    "name": "yin-yang",
    "fontFamily": "fab"
  },
  "showOnCompany": true,
  "showOnLocation": true,
  "showToAllLocations": true,
  "openMode": "iframe",
  "locations": [
    "gfWreTIHL8pDbggBb7af",
    "67WreTIHL8pDbggBb7ty"
  ],
  "userRole": "all",
  "allowCamera": false,
  "allowMicrophone": false
}

application/json

Custom menu successfully updated

application/json

Schema

Schema

successboolean

Status of update

customMenuobject

Updated custom menu link

Example (auto)

{
  "success": true,
  "customMenu": {
    "id": "12345",
    "icon": {
      "name": "yin-yang",
      "fontFamily": "fab"
    },
    "title": "Dashboard",
    "url": "/dashboard",
    "order": 1,
    "showOnCompany": true,
    "showOnLocation": true,
    "showToAllLocations": true,
    "locations": [
      "gfWreTIHL8pDbggBb7af",
      "67WreTIHL8pDbggBb7ty"
    ],
    "openMode": "iframe",
    "userRole": "all",
    "allowCamera": false,
    "allowMicrophone": false
  }
}