Create Custom Menu Link

POST 
/custom-menus/

Creates a new custom menu for a company. Requires authentication and proper permissions. For Icon Usage Details please refer to https://doc.clickup.com/8631005/d/h/87cpx-243696/d60fa70db6b92b2

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

titlestringrequired

Title of the custom menu

urlstringrequired

URL of the custom menu

iconobjectrequired

Icon information for the custom menu

showOnCompanybooleanrequired
Whether the menu must be displayed on the agency's level
Default value: true
showOnLocationbooleanrequired
Whether the menu must be displayed for sub-accounts level
Default value: true
showToAllLocationsbooleanrequired
Whether the menu must be displayed to all sub-accounts
Default value: true
openModestringrequired
Mode for opening the menu link
Available optionsiframenew_tabcurrent_tab
locationsstring[]required

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

userRolestringrequired
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 created

application/json

Schema

Schema

customMenuobject

Single Custom menu link object

Example (auto)

{
  "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
  }
}