User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
User Interface API Request Bodies
Action Input
Action Related List Single Batch Input
Action Related Lists Batch Input
Batch Record Input
Content Input
Batch Operation Input
Favorite Batch Collection Input
Favorite Batch Input
Favorite Input
List Filter By Info Input
List Info Input
List Info Post Input
List Order By Input
List Preferences Input
List Records Input
List Scope Input
List User Preference Input
Lookup Post Input
Navigation Item Collection Input
Navigation Item Input
Page Reference Input
Perform Action Input
Record Input
Related List Input
Related List Records Input
Related List Records Batch Input
Related List User Preferences Input
User Interface API Response Bodies
User Interface API Appendices
PDF

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 Collection Input

A collection of all the navigation items (tabs) for an app. Pass this request body to get or update a user’s personalized navigation items.
JSON Example
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
navItems Navigation Item Input[] The list of navigation items in the order that you want them to appear in the app. Required 47.0