API Reference

Update a Navigation Item

put
https://api.vcita.biz/v3/apps/navigation_items/

Update an existing navigation item. Only provided fields will be updated. Available for Directory tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the navigation item to update (e.g., "nav-item-abc123").

Body Params
string | null

The UID of the parent navigation item. Set to null only for the root item, which represents the logo. Only one root item should exist per directory (e.g., "nav-item-parent123" or null).

integer
≥ 0

Display order within the parent level. Lower numbers appear first (e.g., 0, 1, 2).

title
object

Localized title object. Must include at least the 'en' (English) locale. Additional locales are allowed as additional keys (e.g., "he", "es", "fr").

string | null

Icon identifier from the platform icon library. For a list of supported icon identifiers, refer to the inTandem UI icon library used by the platform. Set to null to remove (e.g., "icon-Dashboard_POV", "icon-Settings" or null).

string
length ≤ 255

Human-readable unique identifier within the directory. Used by API consumers for programmatic access. Must be stable across title/translation changes (e.g., "dashboard", "custom_module").

modules
array of strings | null

Array of module identifiers required for visibility. The list of enabled modules can be retrieved from the features endpoint (e.g., "https://developers.intandem.tech/reference/get_platform-v1-businesses-business-id-features"). Set to null to remove (e.g., ["scheduling", "payments"] or null).

modules
permissions
array of strings | null

Array of permission identifiers required for visibility. To retrieve valid permission codes, use the endpoint (GET "/v3/access_control/permissions"). Set to null to remove (e.g., ["payments.invoices.export", "clients.manage"] or null).

permissions
string | null
enum

Badge code that displays a notification indicator on this navigation item. Supported values are finite and managed by the platform. Set to null to remove (e.g., "inbox_unread" or null).

Allowed:
action

Action configuration that defines the behavior when the navigation item is clicked. Actions are handled by the inTandem JS SDK. Must be one of: NavigateAction or OpenModalAction.

boolean

Whether this navigation item should appear in mobile app navigation. Set to false for desktop-only features (e.g., true, false).

boolean

Whether this item appears in the mobile favorites/quick-access section. Only applicable when available_in_mobile is true (e.g., true, false).

string | null
enum

Behavior when user lacks required modules/permissions. 'hide' removes the item completely, 'show_upsell' displays it with an upgrade prompt. Null means default behavior (hide).

Allowed:
string | null
enum

Semantic role of the navigation item that can trigger special behavior, e.g. "settings" causes a settings cog icon to be displayed in the full menu screen. Null means no special role (e.g., "settings" or null).

Allowed:
string | null

App code name to gate this item by app availability. When set, the item is only visible to staff who have the corresponding app assigned. Must match an existing app's app_code_name. Null means the item is not gated by app availability (e.g., "myapp" or null).

boolean

Indicates if this is a Business Management Platform (BMP) sub-menu item. When set to true, BMP children are built by inTandem internal logic. Available for Directory tokens (e.g., true, false).

Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago