User Interface API Developer Guide
jSummer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Favorite Batch Collection Input
Favorite Batch Input
Favorite Input
List Order By Input
List User Preference Input
Navigation Item Collection Input
Navigation Item Input
Page Reference Input
Record Input
Related List Input
Newer Version Available
User Interface API Request Bodies
The successful execution of a request to a resource can return a response body in JSON
format.
A request to a resource always returns an HTTP response code, whether the request was successful or not.
-
Favorite Batch Collection Input
A collection of all the favorites in a batch. Pass this request body to update a batch of favorites. -
Favorite Batch Input
Represents a single favorite when updating favorites in batch. -
Favorite Input
A favorite to create or update. -
List Order By Input
Information describing how to order a related list. Currently, related lists can be sorted only by one field. Use this request body to update a related list. -
List User Preference Input
A related list user preferences to update. -
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. -
Navigation Item Input
Represents the list of navigation items in the order that you want them to appear in the app. -
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. -
Record Input
A description of a record to use in a request to create or update a record. -
Related List Input
A related list to update.