Update Related List User Preferences

Updates user preferences for a related list.

Resource

1/ui-api/related-list-preferences/${preferencesId}

preferencesId—The ID of user preferences for a related list, for example, Account.RelatedContactList.

Available Version

57.0

HTTP Method

PATCH

Example

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

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

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`relatedListUserPreferencesInput`	Related List User Preferences Input	The related list user preferences to update.	Required	57.0

Response Body

Related List User Preferences

User Interface API Developer Guide

Update Related List User Preferences