Newer Version Available

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

EmailInsight

Represents an insight generated from an email interaction. EmailInsights acts as a central place to store various types of insights related to email messages. The insights stored include status, type, and time of generation. Only certain types of insights can be created based on a pre-configured list of insight types. This object is available in API version 63.0 and later.

Supported Calls

describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules

EmailStream permission must be enabled.

EmailStreamPref and SyncEmailToCoreActivity Org prefs must be enabled.

To be able to see SyncEmailToCoreActivity preference, EACLegacyEmailSyncAWS Org permission, AnalyticsActivity, UnifiedActivities, and ActivityMetrics must be disabled. In addition, license to Standard Einstein Activity Capture and turning on Einstein Activity Capture and EmailInsights provisions the required permissions and preferences.

Fields

Field Details
EmailMessageId
Type
reference
Properties
Filter, Group, Sort
Description
Required. The ID of the email message the insight is generated for.
This field is a relationship field.
Relationship Name
EmailMessage
Refers To
EmailMessage
GeneratedDate
Type
dateTime
Properties
Filter, Sort
Description
Required. The date and time when the insight was generated in the legacy system.
InsightTypeDescription
Type
textarea
Properties
None
Description
Required. Description of the insight type.
InsightTypeIdentifier
Type
string
Properties
Filter, Group, Sort
Description
Required. The ID of the insight type based on which the insight is generated.
InsightTypeLabel
Type
string
Properties
Filter, Group, Sort
Description
Required. The display name of the insight type.
IsLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the email insight record is locked or not.
The default value is false.
LegacyInsightIdentifier
Type
string
Properties
Filter, Group, idLookup, Sort
Description
Required. The unique ID of the insight that was generated and stored in the legacy system.
MayEdit
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the email insight record can be edited or not.
The default value is false.
RowVersion
Type
string
Properties
Defaulted on create, Filter, Group, Sort
Description
A system-generated, read-only field that tracks the version of a record. Each time a record is created or updated, the RowVersion value increments, providing a mechanism to detect changes and manage concurrency.
Status
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Required. The status of the insight record.
Possible values are:
  • Active
  • Completed
  • Deprecated
  • Dismissed
The default value is Active.