Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Navigation Item Input

Represents the list of navigation items in the order that you want them to appear in the app.

Example

1PUT /services/data/v67.0/ui-api/apps/06mRM000000U6pOYAS/user-nav-items

1{
2  "navItems": [{
3    "id": "0QkRM00000058lN0AQ"
4  }, {
5    "id": "0QkRM00000058lR0AQ",
6    "label": "My Top Account"
7  }, {
8    "pageReference": {
9      "type": "standard__objectPage",
10      "attributes": {
11        "objectApiName": "Dashboard",
12        "actionName": "home"
13      },
14      "state": {}
15    }
16  }]
17}

Properties

Name	Type	Description	Required or Optional	Available Version
`id`	String	The ID of the navigation item to include.	Required	47.0
`label`	String	The updated label for the navigation item in list views and records only.	Optional	47.0
`pageReference`	Page Reference Input	The page reference of the navigation item to add to the list. You can add one page reference per request.	Optional	47.0

User Interface API Developer Guide

Navigation Item Input

See Also