Update Related List User Preferences

Updates user preferences for a related list.

Resource

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

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

{ 
  "columnWidths" : {
    "Name" : 200
  },
  "columnWrap" : {
     "Name" : false
  },
  "orderedBy" : [{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }]
}

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