v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB

Menus

Create a menu

post/menus

Headers

organizationstring required

The URL of the end-user web application

channelstring required

The channel ID

Request body

namestring required

Menu item name

iconstring

An image URL

parentIdstring

The ID of the parent menu item. Must have a value in child menu items grouped under a parent.

routestring required

The URL of the page that opens when a user clicks the menu item. Not required for parent menu items.

sortnumber

The position of the menu item in the navigation menu.

Response

Menu created.

idstring required

The menu item ID

organizationstring required

The URL of the end-user web application

channelstring required

The channel ID

statusstring required

Menu item status

iconstring required

The URL of the icon image

namestring required

The menu item name

routestring required

The URL of the page that opens when a user clicks the menu item.

parametersobject required

platformExclusive'WEB' | 'MOBILE' required

Does this menu appear on the web app, the mobile app, or both?

sortnumber required

The position of the menu item in the navigation menu.

deletedboolean required

If True, this menu item has been deleted.

parentstring required

The parent menu item ID

Example response

{
  "id": "61886612d37f875060b4749c",
  "organization": "61bcec0e60d496b329f9c5f5",
  "channel": "61bcec1ea8da6e8874a01c14",
  "status": "active",
  "icon": "icon.png",
  "name": "Menu for FanHero",
  "route": "/home",
  "parameters": {},
  "platformExclusive": "MOBILE",
  "sort": 3,
  "parent": "61886612d37f875060b4749c"
}