Related List Input

A related list to update.

Example

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

PATCH /services/data/v68.0/ui-api/related-list-info/Account/Contracts

{ 
  "orderedByInfo" : [{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }],
  "userPreferences" : {
    "columnWidths" : {
        "Name" : -1
    },
    "columnWrap" : {
        "Name" : false
    }
  }
}

Properties

Name	Type	Description	Required or Optional	Available Version
`orderedByInfo`	List Order By Input[]	A related list’s ordering information. In API version 63.0 and later, you can sort by up to five fields.	Optional	50.0
`userPreferences`	List User Preference Input	A related list’s user preferences.	Optional	50.0

Related List Input

See Also