Get a Batch of Related List Actions with a Request Body

Get the actions on a batch of related lists for a record. 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/batch

recordIds—The 15 or 18 character ID of a record.

Available Version

57.0

HTTP Method

POST

Example

To get information about the actions for the Contacts and Opportunities related lists on an Account record page, use this request with parameters in a request body.

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

1{
2  "relatedListsActionParameters":
3  [
4    {
5      "relatedListId": "Contacts",
6      "apiNames": [ "New" ],
7      "retrievalMode": "All"
8    },
9    {
10      "relatedListId": "Opportunities",
11      "apiNames": ["New" ],
12      "retrievalMode": "All"
13    }
14  ]
15}

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`listRecordActionsQuery`	Action Related Lists Batch Input	The data for a batch of related list actions.	Optional	57.0

Response Body

Simplified Batch Results

User Interface API Developer Guide

Get a Batch of Related List Actions with a Request Body