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.

Related List User Preferences Input

User preferences to update for a related list.

JSON example

To update user preferences for a Contact related list on an Account, use this request with a request body.

1PATCH /services/data/v67.0/ui-api/related-list-preferences/Account.RelatedContactList

1{ 
2  "columnWidths" : {
3    "Name" : 200
4  },
5  "columnWrap" : {
6     "Name" : false
7  },
8  "orderedBy" : [{ 
9    "fieldApiName": "Name",
10    "isAscending" : true
11  }]
12}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`columnWidths`	Map<String, Integer>	Column width preferences for the related list. `-1` indicates default width.	Small, 55.0	55.0
`columnWrap`	Map<String, Boolean>	Indicates whether the column text wraps.	Small, 55.0	55.0
`orderedBy`	List Order By Input[]	Ordering information for the related list. In API version 63.0 and later, you can sort by up to five fields.	Small, 55.0	55.0

User Interface API Developer Guide

Related List User Preferences Input

See Also