---
schema_version: "1"
id: d6598fa5e7c345c8af604f5511461d24cb0686cf0e97b91bfaf2a9e6b687c46f
title: Related List Input
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_requests_related_list_input.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_input.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 91a40a0dc508b184b0edeb9658b7aff60438344c5e4c352c63119893d647f772
description: A related list to update.
---
# 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](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm "Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.")\[\] | 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](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_user_preference_input.htm "A related list user preferences to update.") | A related list’s user preferences. | Optional | 50.0 |

#### See Also

- [Update Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_md_patch.htm "Update metadata for a related list in a page layout.")
- [List Order By Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm "Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.")
- [List User Preference Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_user_preference_input.htm "A related list user preferences to update.")