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 

1/recordalerts/batch

Resource Examples 

1https://{yourInstance}.salesforce.com/services/data/vXX.X/recordalerts/batch?
2whatIds=03R0000026YJ8uIAG,001R0000026YJ8uIAG,00Dx00000004X2F

{yourInstance} is the domain name of your Salesforce instance.

1https://{yourInstance}.salesforce.com/services/data/vXX.X/recordalerts/batch?
2parentIds=03R0000026YJ8uIAG,001R0000026YJ8uIAG,00Dx00000004X2F

Available Version 

55.0

Requires Chatter 

No

HTTP Methods 

GET

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
parentIdsStringThe IDs of the related parent records on which record alerts are created.
For the supported polymorphic objects, see RecordAlert.
Optional
Note: This parameter is required when whatIds aren’t provided.
55.0
whatIdsStringThe Salesforce object record IDs on which record alerts are created.
Note: For internal alerts, whatId can only be polymorphic objects, including all custom objects. For external alerts, whatId can be any valid Salesforce ID.
For the supported polymorphic objects, see RecordAlert.
Optional
Note: This parameter is required when parentIds aren’t provided.
55.0

Response Body for GET 

Record Alert Collection Map