Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Update Related List Metadata

Update metadata for a related list in a page layout.

Resource

1/ui-api/related-list-info/${parentObjectApiName}/${relatedListId}

parentObjectApiName—A supported object, such as Account.
relatedListId—The ID of a supported related list for that object, such as Contracts.

Available Version

50.0

HTTP Method

PATCH

Example

This example uses a request body to update the metadata for the Contracts related list for the Account object:

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

Request Body

Parameter Name	Type	Description	Required or Optional	Available Version
`recordTypeId`	Id	The ID of the record type (RecordType object) for the record. If not provided, the default record type is used.	Optional	50.0
`relatedListInfoInput`	Related List Input	The updated related list metadata.	Required	50.0

Response Body

Related List Info

User Interface API Developer Guide

Update Related List Metadata