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.

List Preferences Input

List preferences to update.

Example

This example updates list preferences for the All Accounts list view.

1PATCH /services/data/v67.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

User Interface API Developer Guide

List Preferences Input

See Also