Endpoint Overview
/api/navigation/v4/menu-items/{menu_item_id}/badge/api/navigation/v4/menu/badge-overview/api/navigation/v4/menu-items/{menu_item_id}/badge/api/navigation/v4/menu/badge-overviewSets the badge count for a specific menu item for the designated users. Note that users and menu items must belong to the same tenant.
The badge count is displayed in the navigation menu and must be managed by the caller; the platform will not automatically decrease or reset the count when a user accesses the menu item.
menu_item_id stringrequiredThe primary identifier of the menu item for which the badge count shall be set.
badges object[]200 OKReturns the badge counts for the authenticated user across all active menu items.
Only active menu items (those visible to the user via their user group assignments) are included.
To retrieve badge counts embedded directly in menu item responses, use embed=BADGE_COUNT on the list menu endpoint instead.
platform stringThe platform parameter allows you to specify the platform for which the menu items should be returned. It can be either MOBILE or WEB. If not specified, the default behavior is to return menu items for both platforms.
200 OK