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.

Page Reference Input

To add a navigation item, include a pageReference. A pageReference is a JSON object that describes the navigation item’s page type, its attributes, and the state of the page.

Example

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

The request body contains the list of navigation items in the order they should appear. To add a navigation item, include a pageReference describing the item.

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
`type`	String	The page reference type generates a unique URL format and defines attributes that apply to all pages of that type. See PageReference Types.	Required	47.0
`attributes`	Map<String, Object>	Map of values for each attribute specified by the page definition, for example, `objectAPIName` or `actionName`.	Required	47.0
`state`	Map<String, Object>	Map of conditional values that customize content on the page, such as `filterName`.	Optional	47.0

User Interface API Developer Guide

Page Reference Input

See Also