Record Alerts (GET)

Retrieve a list of active record alerts.

Resource 

1/recordalerts

Resource Examples 

1https://{yourInstance}.salesforce.com/services/data/{vXX.X}​/recordalerts
2?whatId=a0URO000000Ccbz2AC

{vXX.X} is the API version.

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

1https://{yourInstance}.salesforce.com/services/data/{vXX.X}recordalerts
2?parentId=001RO000002JPkrYAG
1https://{yourInstance}.salesforce.com/services/data/{vXX.X}recordalerts
2?whatId=a0URO000000Ccbz2AC&parentId=001RO000002JPkrYAG

Available Version 

54.0

Requires Chatter 

No

HTTP Methods 

GET

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
parentIdStringThe related parent record ID on which a record alert is created.Optional54.0
whatIdStringThe Salesforce object record ID on which a record alert is created.
Note: For external alerts, whatId can be any valid Salesforce ID. For internal alerts, whatId can only be polymorphic objects including all custom objects.
Supported polymorphic objects are:
  • Account
  • Asset
  • BusinessMilestone
  • Campaign
  • Contract
  • Contact
  • Case
  • Claim
  • InsurancePolicy
  • InsurancePolicyCoverage
  • InteractionSummary
  • Lead
  • LoanApplication
  • LoanApplicantEmployment
  • LoanApplicantIncome
  • LoanApplicationProperty
  • LoanApplicationFinancial
  • LoanApplicationAsset
  • LoanApplicationLiability
  • Opportunity
  • PersonLifeEvent
  • ResidentialLoanApplication
  • All Custom Objects
Required54.0

Response Body for GET 

Record Alert Collection