User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
User Interface API Request Bodies
Favorite Batch Collection Input
Favorite Batch Input
Favorite Input
List Order By Input
List User Preference Input
Navigation Item Collection Input
Navigation Item Input
Page Reference Input
Record Input
Related List Input
Related List Records Input
Related List Records Batch Input
User Interface API Response Bodies
Supported Objects
PDF

Newer Version Available

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

List User Preference Input

A related list user preferences to update.
Example
This example uses a request body to update the metadata for the Contracts related list for the Account object:
1PATCH /services/data/v56.0/ui-api/related-list-info/Account/Contracts
1{ 
2  "orderedByInfo" : [{ 
3    "fieldApiName": "Name",
4    "isAscending" : true
5  }],
6  "userPreferences" : {
7    "columnWidths" : {
8        "Name" : -1
9    },
10    "columnWrap" : {
11        "Name" : false
12    }
13  }
14}
Properties
Name Type Description Required or Optional Available Version
columnWidths Map<String, Integer> Column width preferences.-1 indicates default width. Optional 50.0
columnWrap Map<String, Boolean> Indicates whether the column text wraps. Optional 50.0