Newer Version Available

This content describes an older version of this product. View Latest

Record Alerts (Person Accounts)

Retrieve a list of active record alerts on person accounts.
The following is a list of alerts retrieved for a person account:
  • Alerts for the specified person account.
  • Alerts for the financial accounts owned by the person.
  • Alerts on financial transactions that are related to the financial accounts.
Resource
1/financialservices/recordalerts/person/${personId}
Resource Examples
1https://yourInstance.salesforce.com/services/data/vXX.X/financialservices
2/recordalerts/person/001RO000002Kn4BYAS
Available version
54.0
Requires Chatter
No
HTTP methods
GET
Response body for GET
Record Alert Collection
JSON example of response body
1{
2   "recordAlerts" : [ {
3      "actions" : {
4      "actionInfoCollection" : [ {
5        "actionName" : "dismiss",
6        "parameters" : [ ]
7      }, {
8        "actionName" : "snooze",
9        "parameters" : [ "effectiveDate" ]
10      } ]
11      },
12      "description" : "Alert description from an external source system",
13      "severity" : "Test",
14      "source" : "External",
15      "sourceSystemId" : "sourceSystemId",
16      "subject" : "foo apex subject",
17      "whatId" : "001RO000002Kn4BYAS"
18   }, {
19      "actions" : {
20        "actionInfoCollection" : [ {
21          "actionName" : "dismiss",
22          "parameters" : [ ]
23        }, {
24          "actionName" : "snooze",
25          "parameters" : [ "effectiveDate" ]
26        } ]
27      },
28      "active" : true,
29      "description" : "Unauthorized transaction on card",
30      "effectiveDate" : "2021-11-10T20:00:00.000Z",
31      "id" : "0qZRO000000003Z",
32      "recordAlertCategoryName" : "Fraud",
33      "severity" : "Error",
34      "source" : "Internal",
35      "subject" : "Fraud Transaction 3",
36      "validUntilDate" : "2022-11-10T20:00:00.000Z",
37      "whatId" : "001RO000002Kn4B"
38   }, {
39      "actions" : {
40        "actionInfoCollection" : [ {
41          "actionName" : "dismiss",
42          "parameters" : [ ]
43        }, {
44          "actionName" : "snooze",
45          "parameters" : [ "effectiveDate" ]
46        } ]
47      },
48      "active" : true,
49      "description" : "Your card was used in a fraudulent transaction on 11/4/2021",
50      "effectiveDate" : "2021-11-10T20:00:00.000Z",
51      "id" : "0qZRO000000003K",
52      "recordAlertCategoryName" : "Fraud",
53      "severity" : "Error",
54      "source" : "Internal",
55      "subject" : "Fraud Transaction Alert",
56      "validUntilDate" : "2022-11-04T19:00:00.000Z",
57      "whatId" : "001RO000002Kn4B"
58   } ]
59}