---
schema_version: "1"
id: a312cc805c737e9403621f26c7517cd0f05d45ff9dae6dbafc86fe8832f15736
title: List Order By Input
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_requests_list_order_by_input.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 58e989f7bf135a0f4fd64d037d074f12d0aab4384d0f165cfdbeaed3f264ef20
description: 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 Order By Input

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.

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 |
| --- | --- | --- | --- | --- |
| fieldApiName | String | The API name for the field. | Optional | 50.0 |
| isAscending | Boolean | Indicates whether the list column is ascending or descending. | Optional | 50.0 |

#### See Also

- [Related List Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_input.htm "A related list to update.")
- [Related List User Preferences Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_user_preferences_input.htm "User preferences to update for a related list.")
- [List Preferences Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_preferences_input.htm "List preferences to update.")
- [Lookup Post Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_lookup_post_input.htm "Get lookup field suggestions.")