User Interface API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Update Related List Metadata
- Resource
-
/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:
PATCH /services/data/v64.0/ui-api/related-list-info/Account/Contracts{ "orderedByInfo" : [{ "fieldApiName": "Name", "isAscending" : true }], "userPreferences" : { "columnWidths" : { "Name" : -1 }, "columnWrap" : { "Name" : false } } } - 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