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

Newer Version Available

This content describes an older version of this product. View Latest

List Preferences Input

List preferences to update.
Example
This example updates list preferences for the All Accounts list view.
1PATCH /services/data/v65.0/ui-api/list-preferences/Account/AllAccounts
1{
2"columnWidths" : {
3  "Name" : 200
4  },
5"columnWrap" : {
6  "Name" : false
7  },
8"orderedBy" : [{
9  "fieldApiName": "Name",
10  "isAscending" : true
11  }]
12}
Properties
Name Type Description Required or Optional Available Version
columnWidths Map<String, Integer> Column width preferences to update. If you pass a null value, preferences reset to the default. Optional 61.0
columnWrap Map<String, Boolean> Column wrap preferences to update. If you pass a null value, preferences reset to the default. Optional 61.0
orderedBy List Order By Input[] Ordering preferences to update. If you pass a null value, preferences reset to the default.

In API version 63.0 and later, you can sort by up to five columns. In earlier versions, results are sorted by the first column.

 Optional 61.0