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.

Get Related List Actions with a Request Body

Get the actions on related lists for a record detail page. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.

Resources

1/ui-api/actions/record/${recordIds}/related-list/${relatedListId}

recordIds—The 15 or 18 character ID of a record.
relatedListId—(Optional) A related list ID. If this parameter isn’t specified, the request returns all related list actions for the specified record. To get actions for a batch of related lists, see Get a Batch of Related List Actions with a Request Body.

Available Version

57.0

HTTP Method

POST

Example

To get information about related list actions on a record detail page, use this request with a request body.

1POST /services/data/v67.0/ui-api/actions/record/001R0000003IDlwIAG/related-list

1{
2  "apiNames": ["New"],
3  "retrievalMode": "All"
4}

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`listRecordActionsQuery`	Action Input	The data for related list actions.	Optional	57.0

Response Body

Action

User Interface API Developer Guide

Get Related List Actions with a Request Body