Salesforce Docs Portal

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.

PATCH /services/data/v68.0/ui-api/related-list-preferences/Account.RelatedContactList
{ 
  "columnWidths" : {
    "Name" : 200
  },
  "columnWrap" : {
     "Name" : false
  },
  "orderedBy" : [{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }]
}
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