RecordAlert

Represents an alert message about a specific record and tracks the status and active period of the alert. This object is available in API version 65.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AdditionalMessage

Type: textarea
Properties: Create, Nillable, Update
Description: The additional details of the message that are communicated in the alert. This field contains information such as the tag, alert action, URL, or color.

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The detailed description of the alert.

EffectiveDate

Type: dateTime
Properties: Create, Filter, Sort, Update
Description: The date and time that the alert was generated or became active.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the alert is still active (true) or has been dismissed (false).
Default value: false

IsSilent

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the alert is silent or not.
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record or list view.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the record alert.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the owner of the record alert.

This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User

ParentId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The user, account, or contact associated with the alert.

This field is a polymorphic relationship field.
Relationship Name: Parent
Refers To: Account, ApplicationForm, Asset, BenefitAssignment, BenefitDisbursement, BenefitManagementRecertification__c, BusinessMilestone, Case, Claim, Contact, Contract, GoalAssignment, IndividualApplication, InsurancePolicy, InsurancePolicyCoverage, Lead, LoanApplicant, LoanApplicantEmployment, LoanApplicantIncome, LoanApplicationAsset, LoanApplicationFinancial, LoanApplicationLiability, LoanApplicationProperty, Opportunity, PersonLifeEvent, ResidentialLoanApplication, User, lsc4ce__Foo__c, omnistudio__CardFrameworkConfiguration__c, omnistudio__DRBatchQueue__c, omnistudio__DRBulkData__c, omnistudio__DREncryption__c, omnistudio__DRWorker__c, omnistudio__Interface_DRGeneric__c, omnistudio__TestResult__c, omnistudio__TriggerSetup__c, omnistudio__UISettings__c, omnistudio__VlocityDataPack__c, omnistudio__VlocityDocuSignTemplate__c, omnistudio__VlocityErrorLogEntry__c, omnistudio__VlocityScheduledJob__c, omnistudio__VlocityTrackingEntry__c

RecordAlertCategoryId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The category for the alert.

This field is a relationship field.
Relationship Name: RecordAlertCategory
Refers To: RecordAlertCategory

Severity

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The severity of the alert.
Possible values:
- Error
- Info
- Warning

SnoozeUntilDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date until which the alert is snoozed.

SourceSystemIdentifier

Type: string
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
Description: The identifier of the record in the source system.

Subject

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The subject of the alert.

Type

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the alert type.
Possible values:
- GuidedAction
- Notification
- Recommendation

ValidUntilDate

Type: dateTime
Properties: Create, Filter, Sort, Update
Description: The date and time when the alert becomes invalid.

WhatId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The record that the alert pertains to.

This field is a polymorphic relationship field.
Relationship Name: What
Refers To: Account, AccountPlan, AccountPlanObjective, ActionPlan, ApplicationForm, ApplicationFormProduct, AssessmentTask, Asset, BenefitAssignment, BenefitDisbursement, BenefitManagementRecertification__c, BusinessMilestone, Case, Claim, Contact, Contract, Event, GoalAssignment, IndividualApplication, InsurancePolicy, InsurancePolicyCoverage, Lead, LifeScienceEmail, LoanApplicant, LoanApplicantEmployment, LoanApplicantIncome, LoanApplicationAsset, LoanApplicationFinancial, LoanApplicationLiability, LoanApplicationProperty, MedicalInsight, OmniScriptSavedSession, Opportunity, Order, PartyRelationshipGroup, PersonLifeEvent, Presentation, ResidentialLoanApplication, User, Visit, lsc4ce__Foo__c, omnistudio__CardFrameworkConfiguration__c, omnistudio__DRBatchQueue__c, omnistudio__DRBulkData__c, omnistudio__DREncryption__c, omnistudio__DRWorker__c, omnistudio__Interface_DRGeneric__c, omnistudio__TestResult__c, omnistudio__TriggerSetup__c, omnistudio__UISettings__c, omnistudio__VlocityDataPack__c, omnistudio__VlocityDocuSignTemplate__c, omnistudio__VlocityErrorLogEntry__c, omnistudio__VlocityScheduledJob__c, omnistudio__VlocityTrackingEntry__c