Internal Record Alert Actions (POST)

Snooze internal record alerts for a specified time period or dismiss them.

Resource 

1/recordalerts/id/${alertId}/actions

Resource Examples 

1https://{yourInstance}.salesforce.com/services/data/{vXX.X}/recordalerts
2/id/0qZRO000000005a2AA/actions

{vXX.X} is the API version.

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

Available Version 

54.0

Requires Chatter 

No

HTTP Methods 

POST

Request Body for POST 

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 

NameTypeDescriptionRequired or OptionalAvailable Version
actionNameStringThe 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.
Required54.0
actionParametersRecord Alert Action Parameter Input[]Represents the parameter specified for the record alert action.Optional54.0

Response Body for POST 

Record Alert