Update Personalized Navigation Items

Updates the order of a user’s personalized navigation items (tabs) and adds a navigation item to the list in the order specified.

Resource

1/ui-api/apps/{appId}/user-nav-items

Available Version

47.0

HTTP Method

PUT

Example

To update the order that navigation items display in an app and add an item to the list, make this request using the app’s ID.

1PUT /services/data/v52.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}

The request returns metadata for the navigation items associated with this app.

1{
2  "currentPageUrl": "/services/data/v52.0/ui-api/apps/06mRM000000U6pOYAS/user-nav-items?formFactor=large",
3  "navItems": [{
4    "availableInClassic": true,
5    "availableInLightning": true,
6    "color": "2ECBBE",
7    "content": "https://yourinstance.salesforce.com/00O/o",
8    "custom": false,
9    "developerName": "standard-report",
10    "iconUrl": "https://yourinstance.salesforce.com/img/icon/t4v35/standard/report_120.png",
11    "id": "0QkRM00000058lN0AQ",
12    "itemType": "Entity",
13    "label": "Cars",
14    "objectApiName": "Car__c",
15    "objectLabel": "Car",
16    "objectLabelPlural": "Cars",
17    "pageReference": {
18      "attributes": {
19        "objectApiName": "Car__c",
20        "actionName": "home"
21      },
22      "state": {},
23      "type": "standard__objectPage"
24    },
25    "standardType": null
26  }, {
27    "availableInClassic": false,
28    "availableInLightning": true,
29    "color": "7F8DE1",
30    "content": "001RM000004QlpqYAC",
31    "custom": true,
32    "developerName": null,
33    "iconUrl": "https://yourinstance.salesforce.com/img/icon/t4v35/standard/account_120.png",
34    "id": "0QkRM00000058lR0AQ",
35    "itemType": "Record",
36    "label": "My Top Account",
37    "objectApiName": "Account",
38    "objectLabel": "Account",
39    "objectLabelPlural": "Accounts",
40    "pageReference": {
41      "attributes": {
42        "recordId": "001RM000004QlpqYAC",
43        "objectApiName": "Account",
44        "actionName": "view"
45      },
46      "state": {},
47      "type": "standard__recordPage"
48    },
49    "standardType": null
50  }, {
51    "availableInClassic": true,
52    "availableInLightning": true,
53    "color": "EF6E64",
54    "content": "https://yourinstance.salesforce.com/01Z/o",
55    "custom": false,
56    "developerName": "standard-Dashboard",
57    "iconUrl": "https://yourinstance.salesforce.com/img/icon/t4v35/standard/dashboard_120.png",
58    "id": "0QkRM00000058ll0AA",
59    "itemType": "Standard",
60    "label": "Dashboards",
61    "objectApiName": "Dashboard",
62    "objectLabel": "Dashboard",
63    "objectLabelPlural": "Dashboards",
64    "pageReference": {
65      "attributes": {
66        "objectApiName": "Dashboard",
67        "actionName": "home"
68      },
69      "state": {},
70      "type": "standard__objectPage"
71    },
72    "standardType": "Dashboards"
73  }],
74  "nextPageUrl": null
75}

Request Body

Name	Type	Description	Required or Optional	Available Version
`navItems`	Navigation Item Collection Input	A list of navigation items (tabs) in the updated order they should appear. The updated order persists across desktop and mobile environments.	Required	47.0

Response Body

Navigation Items

User Interface API Developer Guide

Update Personalized Navigation Items