API Reference

Create a Navigation Item

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

Create a new navigation item for the authenticated directory. The directory_uid is automatically set from the authenticated token context. Available for Directory tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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").

integer
≥ 0
Defaults to 0

Display order within the parent level (e.g., 0, 1, 2).

title
object
required

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 (e.g., "icon-Dashboard_POV").

string
required
length ≤ 255

Human-readable unique identifier within the directory (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"). (e.g., ["scheduling", "payments"]).

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"). (e.g., ["payments.invoices.export", "clients.manage"]).

permissions
string | null
enum

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

Allowed:
action
required

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

boolean
Defaults to true

Whether to show in mobile navigation (e.g., true, false).

boolean
Defaults to false

Whether to show in mobile favorites section (e.g., true, false).

string | null
enum

Behavior when user lacks permissions. 'hide' removes the item, 'show_upsell' displays 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
Defaults to false

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