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
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

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/v64.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