Record Alerts APIs

Use the Record Alerts Business APIs to give users a seamless API experience for Record Alerts.

The Record Alerts API allows you to retrieve a list of active record alerts created on the Salesforce object records. As alerts generate, you can perform an action to snooze the alerts for a specified time or dismiss them.

The Record Alert system doesn’t support sending of SMS, email, or push based alerts to users.

Note

Available resources are:

Resource	Description
`/recordalerts`	Retrieve a list of active record alerts.
`/recordalerts/id/${alertId}/actions`	Dismiss or snooze an internal record alert.
`/recordalerts/externalId/${sourceSystemId}/actions`	Dismiss or snooze an external record alert.
`/recordalerts/batch`	Retrieve bulk record alerts.
`/recordalerts/ids/actions`	Snooze bulk internal record alerts for a specified time period or dismiss them.
`/recordalerts/externalIds/actions`	Snooze bulk external record alerts for a specified time period or dismiss them.

REST Reference

You can access Record Alerts APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs.