User Interface API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with User Interface API
User Interface API Features
User Interface API Resources
Records
Actions
Favorites
Lists
Apps
Get Apps
Get an App
Update Last Selected App
Get Last Selected App
Get Personalized Navigation Items
Get All Navigation Items
Update Personalized Navigation Items
Get Active Theme
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
PDF

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
/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.

PUT /services/data/v64.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.

{
  "navItems": [{
    "id": "0QkRM00000058lN0AQ"
  }, {
    "id": "0QkRM00000058lR0AQ",
    "label": "My Top Account"
  }, {
    "pageReference": {
      "type": "standard__objectPage",
      "attributes": {
        "objectApiName": "Dashboard",
        "actionName": "home"
      },
      "state": {}
    }
  }]
}

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

{
  "currentPageUrl": "/services/data/v64.0/ui-api/apps/06mRM000000U6pOYAS/user-nav-items?formFactor=large",
  "navItems": [{
    "availableInClassic": true,
    "availableInLightning": true,
    "color": "2ECBBE",
    "content": "https://yourinstance.salesforce.com/00O/o",
    "custom": false,
    "developerName": "standard-report",
    "iconUrl": "https://yourinstance.salesforce.com/img/icon/t4v35/standard/report_120.png",
    "id": "0QkRM00000058lN0AQ",
    "itemType": "Entity",
    "label": "Cars",
    "objectApiName": "Car__c",
    "objectLabel": "Car",
    "objectLabelPlural": "Cars",
    "pageReference": {
      "attributes": {
        "objectApiName": "Car__c",
        "actionName": "home"
      },
      "state": {},
      "type": "standard__objectPage"
    },
    "standardType": null
  }, {
    "availableInClassic": false,
    "availableInLightning": true,
    "color": "7F8DE1",
    "content": "001RM000004QlpqYAC",
    "custom": true,
    "developerName": null,
    "iconUrl": "https://yourinstance.salesforce.com/img/icon/t4v35/standard/account_120.png",
    "id": "0QkRM00000058lR0AQ",
    "itemType": "Record",
    "label": "My Top Account",
    "objectApiName": "Account",
    "objectLabel": "Account",
    "objectLabelPlural": "Accounts",
    "pageReference": {
      "attributes": {
        "recordId": "001RM000004QlpqYAC",
        "objectApiName": "Account",
        "actionName": "view"
      },
      "state": {},
      "type": "standard__recordPage"
    },
    "standardType": null
  }, {
    "availableInClassic": true,
    "availableInLightning": true,
    "color": "EF6E64",
    "content": "https://yourinstance.salesforce.com/01Z/o",
    "custom": false,
    "developerName": "standard-Dashboard",
    "iconUrl": "https://yourinstance.salesforce.com/img/icon/t4v35/standard/dashboard_120.png",
    "id": "0QkRM00000058ll0AA",
    "itemType": "Standard",
    "label": "Dashboards",
    "objectApiName": "Dashboard",
    "objectLabel": "Dashboard",
    "objectLabelPlural": "Dashboards",
    "pageReference": {
      "attributes": {
        "objectApiName": "Dashboard",
        "actionName": "home"
      },
      "state": {},
      "type": "standard__objectPage"
    },
    "standardType": "Dashboards"
  }],
  "nextPageUrl": null
}
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