Bulk Record Alerts (GET)

Retrieve bulk record alerts. Use to fetch bulk record alerts associated with Salesforce objects and parent accounts.

You cannot use a combination of whatIds and parentIds to fetch record alerts in bulk.

Note

Resource
/recordalerts/batch
Resource Examples
https://yourInstance.salesforce.com/services/data/vXX.X/recordalerts/batch?
whatIds=03R0000026YJ8uIAG,001R0000026YJ8uIAG,00Dx00000004X2F
https://yourInstance.salesforce.com/services/data/vXX.X/recordalerts/batch?
parentIds=03R0000026YJ8uIAG,001R0000026YJ8uIAG,00Dx00000004X2F
Available version
55.0
Requires Chatter
No
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
parentIds String The IDs of the related parent records on which record alerts are created.

For the supported polymorphic objects, see RecordAlert.

Optional

This parameter is required when whatIds aren't provided.

Note

55.0
whatIds String The Salesforce object record IDs on which record alerts are created.

For internal alerts, whatId can only be polymorphic objects, including all custom objects. For external alerts, whatId can be any valid Salesforce ID. 

Note

For the supported polymorphic objects, see RecordAlert.

Optional

This parameter is required when parentIds aren't provided.

Note

55.0
Response body for GET
Record Alert Collection Map