User Interface API Developer Guide
Summer '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)
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
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.
-
Action Input
Get the actions on related lists on a record detail page. -
Action Related List Single Batch Input
Get the actions on a batch of related lists for a record. -
Action Related Lists Batch Input
Get the actions on a batch of related lists for a record. -
Batch Record Input
A description of multiple operations for a request to create, update, or delete a batch of records. -
Content Input
Upload a file or a new file version. -
Batch Operation Input
Represents the operation type and record data to create, update, and delete in a batch. -
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 Filter By Info Input
List filter by info to update or create. -
List Info Input
Info to update a list. -
List Info Post Input
Info to create a list. -
List Order By Input
Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list. -
List Preferences Input
List preferences to update. -
List Records Input
Record data to query for a list view. -
List Scope Input
List scope to update or create. -
List User Preference Input
A related list user preferences to update. -
Lookup Post Input
Get lookup field suggestions. -
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. -
Perform Action Input
Perform a quick action that creates or updates a record. -
Record Input
A description of a record to use in a request to create or update a record or in a request to check for duplicate records. -
Related List Input
A related list to update. -
Related List Records Input
Get record data for up to 1,999 records in a related list. -
Related List Records Batch Input
Get record data for a batch of related lists. -
Related List User Preferences Input
User preferences to update for a related list.