HighLevel: Custom menus schemas
10 HighLevel schemas with complete fields and constraints.
← Custom menus operations · All schemas
Create Custom Menu Link — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowCamera | boolean | Optional | Whether to allow camera access (only for iframe mode) |
allowMicrophone | boolean | Optional | Whether to allow microphone access (only for iframe mode) |
icon | JSON | Required within parent | Icon information for the custom menu |
icon (allOf 1) | Model | All variants apply | Expand Create Custom Menu Link — request body — body / icon / fontFamily: fab, fas, far |
locations | array | Required within parent | List of sub-account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false |
locations[] | string | Each item | |
openMode | string | Required within parent | Mode for opening the menu link One of: iframe, new_tab, current_tab |
showOnCompany | boolean | Required within parent | Whether the menu must be displayed on the agency's level Default: true |
showOnLocation | boolean | Required within parent | Whether the menu must be displayed for sub-accounts level Default: true |
showToAllLocations | boolean | Required within parent | Whether the menu must be displayed to all sub-accounts Default: true |
title | string | Required within parent | Title of the custom menu |
url | string | Required within parent | URL of the custom menu |
userRole | string | Required within parent | Which user-roles should the menu be accessible to? One of: all, admin, user |
Referenced models: Create Custom Menu Link — request body — body / icon / fontFamily: fab, fas, far
Create Custom Menu Link — request body — body / icon / fontFamily: fab, fas, far
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fontFamily | string | Required within parent | Font family of the icon One of: fab, fas, far |
name | string | Required within parent | Name of the icon |
Delete Custom Menu Link — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deletedAt | string | Optional | Timestamp of when the deletion was performed Format: date-time |
deletedMenuId | string | Optional | The ID of the deleted custom menu |
message | string | Optional | A message providing additional information about the deletion operation |
success | boolean | Optional | Indicates whether the custom menu was successfully deleted |
Get Custom Menu Link — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customMenu | JSON | Optional | Single Custom menu link object |
customMenu (allOf 1) | Model | All variants apply | Expand Get Custom Menu Links — response body — custom Menus item |
Referenced models: Get Custom Menu Links — response body — custom Menus item
Get Custom Menu Links — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customMenus | array | Optional | Array of custom menu links |
customMenus[] | Model | Each item | Expand Get Custom Menu Links — response body — custom Menus item |
totalLinks | JSON | Optional | |
totalLinks (anyOf 1) | number | Alternative | Total number of custom menu records |
totalLinks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get Custom Menu Links — response body — custom Menus item
Get Custom Menu Links — response body — custom Menus item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowCamera | boolean | Optional | Indicates if camera access is allowed for this menu |
allowMicrophone | boolean | Optional | Indicates if microphone access is allowed for this menu |
icon | JSON | Optional | Icon information for the menu item |
icon (allOf 1) | Model | All variants apply | Expand Get Custom Menu Links — response body — customMenus / item / icon / fontFamily: fab, fas, far |
id | string | Optional | Unique identifier for the custom menu |
locations | array | Optional | List of sub-account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false |
locations[] | string | Each item | |
openMode | string | Optional | Mode for opening the menu link Known values: iframe, new_tab, current_tab |
order | JSON | Optional | |
order (anyOf 1) | number | Alternative | Order of the custom menu |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
showOnCompany | boolean | Optional | Filter to show only agency-level menu links. When omitted, fetches both agency and sub-account menu links. Ignored if locationId is provided |
showOnLocation | boolean | Optional | Whether the menu must be displayed for sub-accounts level |
showToAllLocations | boolean | Optional | Whether the menu must be displayed to all sub-accounts |
title | string | Optional | Title of the custom menu |
url | string | Optional | URL of the custom menu |
userRole | string | Optional | Which user-roles should the menu be accessible to? Known values: all, admin, user |
Referenced models: Get Custom Menu Links — response body — customMenus / item / icon / fontFamily: fab, fas, far
Get Custom Menu Links — response body — customMenus / item / icon / fontFamily: fab, fas, far
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fontFamily | string | Optional | Font family of the icon Known values: fab, fas, far |
name | string | Optional | Name of the icon |
Update Custom Menu Link — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowCamera | boolean | Optional | Whether to allow camera access (only for iframe mode) |
allowMicrophone | boolean | Optional | Whether to allow microphone access (only for iframe mode) |
icon | JSON | Optional | Icon information for the custom menu |
icon (allOf 1) | Model | All variants apply | Expand Update Custom Menu Link — request body — body / icon / fontFamily: fab, fas, far |
locations | array | Optional | List of sub-account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false |
locations[] | string | Each item | |
openMode | string | Optional | Mode for opening the menu link One of: iframe, new_tab, current_tab |
showOnCompany | boolean | Optional | Whether the menu must be displayed on the agency's level Default: true |
showOnLocation | boolean | Optional | Whether the menu must be displayed for sub-accounts level Default: true |
showToAllLocations | boolean | Optional | Whether the menu must be displayed to all sub-accounts Default: true |
title | string | Optional | Title of the custom menu |
url | string | Optional | URL of the custom menu |
userRole | string | Optional | Which user-roles should the menu be accessible to? One of: all, admin, user |
Referenced models: Update Custom Menu Link — request body — body / icon / fontFamily: fab, fas, far
Update Custom Menu Link — request body — body / icon / fontFamily: fab, fas, far
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fontFamily | string | Optional | Font family of the icon One of: fab, fas, far |
name | string | Optional | Name of the icon |
Update Custom Menu Link — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customMenu | JSON | Optional | Updated custom menu link |
customMenu (allOf 1) | Model | All variants apply | Expand Get Custom Menu Links — response body — custom Menus item |
success | boolean | Optional | Status of update |
Referenced models: Get Custom Menu Links — response body — custom Menus item