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.
External Record Alert Actions (POST)
Snooze external record alerts that are from an external source system
for a specified time period or dismiss them.
- Resource
-
1/recordalerts/externalId/${sourceSystemId}/actions - Resource Examples
-
1https://yourInstance.salesforce.com/services/data/vXX.X/recordalerts 2/externalId/254be9562893/actions - Available version
- 54.0
- Requires Chatter
- No
- HTTP methods
- POST
- Request body for POST
-
- Root XML tag
- RecordAlertActionInput
- JSON example
-
Dismiss a record alert:
1{ 2 "actionName": "dismiss" 3}Snooze a record alert:1{ 2 "actionParameters": [ { 3 "name": "effectiveDate", 4 "value": "2021-12-11T02:16:35.477Z" 5 } ], 6 "actionName": "snooze" 7} - Properties
-
Name Type Description Required or Optional Available Version actionName String The action to perform on a record alert. Possible values are:- Dismiss—The record alert notification doesn’t appear again.
- Snooze—The record alert notification reappears after the specified time period.
Required 54.0 actionParameters Record Alert Action Parameter Input[] Represents the parameter specified for the record alert action. Optional 54.0
- Response body for POST
- Record Alert