Email Entity Reference

Activity that is delivered using email protocols.

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/emails(activityid)
Update ownerid property.
AssignRequest
BackgroundSendEmail BackgroundSendEmail Action BackgroundSendEmailRequest
CheckIncomingEmail CheckIncomingEmail Function CheckIncomingEmailRequest
CheckPromoteEmail CheckPromoteEmail Function CheckPromoteEmailRequest
Create POST [org URI]/api/data/v9.0/emails
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/emails(activityid)
See Delete
DeleteRequest or
Delete
DeliverImmediatePromoteEmail Microsoft.Dynamics.CRM.DeliverImmediatePromoteEmail DeliverImmediatePromoteEmailRequest
DeliverIncomingEmail DeliverIncomingEmail Action DeliverIncomingEmailRequest
DeliverPromoteEmail DeliverPromoteEmail Action DeliverPromoteEmailRequest
GetTrackingTokenEmail GetTrackingTokenEmail Action GetTrackingTokenEmailRequest
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/emails(activityid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/emails
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SendEmail SendEmail Action SendEmailRequest
SendEmailFromTemplate SendEmailFromTemplate Action SendEmailFromTemplateRequest
SendFax SendFax Action SendFaxRequest
SendTemplate SendTemplate Action SendTemplateRequest
SetState PATCH [org URI]/api/data/v9.0/emails(activityid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/emails(activityid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Emails
DisplayCollectionName Email Messages
DisplayName Email
EntitySetName emails
IsBPFEntity False
LogicalCollectionName emails
LogicalName email
OwnershipType UserOwned
PrimaryIdAttribute activityid
PrimaryNameAttribute subject
SchemaName Email

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ActivityAdditionalParams

Property Value
Description For internal use only.
DisplayName Additional Parameters
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName activityadditionalparams
MaxLength 8192
RequiredLevel None
Type Memo

ActivityId

Property Value
Description Unique identifier of the email activity.
DisplayName Email Message
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName activityid
RequiredLevel SystemRequired
Type Uniqueidentifier

ActualDurationMinutes

Property Value
Description Type the number of minutes spent creating and sending the email. The duration is used in reporting.
DisplayName Duration
Format Duration
IsValidForForm True
IsValidForRead True
LogicalName actualdurationminutes
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

ActualEnd

Property Value
DateTimeBehavior UserLocal
Description Enter the actual end date and time of the email. By default, it displays the date and time when the activity was completed or canceled, but can be edited to capture the actual time to create and send the email.
DisplayName Actual End
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName actualend
RequiredLevel None
Type DateTime

ActualStart

Property Value
DateTimeBehavior UserLocal
Description Enter the actual start date and time for the email. By default, it displays the date and time when the activity was created, but can be edited to capture the actual time to create and send the email.
DisplayName Actual Start
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName actualstart
RequiredLevel None
Type DateTime

AttachmentOpenCount

Property Value
Description Shows the number of times an email attachment has been viewed.
DisplayName Attachment Open Count
Format None
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName attachmentopencount
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

BaseConversationIndexHash

Property Value
Description Hash of base of conversation index.
DisplayName Conversation Index (Hash)
Format None
IsValidForForm False
IsValidForRead True
LogicalName baseconversationindexhash
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

bcc

Property Value
Description Enter the recipients that are included on the email distribution, but are not displayed to other recipients.
DisplayName Bcc
IsValidForForm True
IsValidForRead True
LogicalName bcc
RequiredLevel None
Targets account,contact,knowledgearticle,queue,systemuser,unresolvedaddress
Type PartyList

Category

Property Value
Description Type a category to identify the email type, such as lead outreach, customer follow-up, or service alert, to tie the email to a business group or function.
DisplayName Category
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName category
MaxLength 250
RequiredLevel None
Type String

cc

Property Value
Description Enter the recipients that should be copied on the email.
DisplayName Cc
IsValidForForm True
IsValidForRead True
LogicalName cc
RequiredLevel None
Targets account,contact,knowledgearticle,queue,systemuser,unresolvedaddress
Type PartyList

ConversationTrackingId

Property Value
Description Conversation Tracking Id.
DisplayName Conversation Tracking Id
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName conversationtrackingid
RequiredLevel None
Type Uniqueidentifier

DelayedEmailSendTime

Property Value
DateTimeBehavior UserLocal
Description Enter the expected date and time when email will be sent.
DisplayName Send Later
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName delayedemailsendtime
RequiredLevel None
Type DateTime

DeliveryAttempts

Property Value
Description Shows the count of the number of attempts made to send the email. The count is used as an indicator of email routing issues.
DisplayName No. of Delivery Attempts
Format None
IsValidForForm True
IsValidForRead True
LogicalName deliveryattempts
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

DeliveryPriorityCode

Property Value
Description Select the priority of delivery of the email to the email server.
DisplayName Delivery Priority
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName deliveryprioritycode
RequiredLevel None
Type Picklist

DeliveryPriorityCode Options

Value Label
0 Low
1 Normal
2 High

DeliveryReceiptRequested

Property Value
Description Select whether the sender should receive confirmation that the email was delivered.
DisplayName Delivery Receipt Requested
IsValidForForm False
IsValidForRead True
LogicalName deliveryreceiptrequested
RequiredLevel None
Type Boolean

DeliveryReceiptRequested Options

Value Label
1 Yes
0 No

DefaultValue: False

Description

Property Value
Description Type the greeting and message text of the email.
DisplayName Description
Format Email
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 1073741823
RequiredLevel None
Type Memo

DirectionCode

Property Value
Description Select the direction of the email as incoming or outbound.
DisplayName Direction
IsValidForForm True
IsValidForRead True
LogicalName directioncode
RequiredLevel None
Type Boolean

DirectionCode Options

Value Label
1 Outgoing
0 Incoming

DefaultValue: True

EmailReminderExpiryTime

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when an email reminder expires.
DisplayName Email Reminder Expiry Time
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName emailreminderexpirytime
RequiredLevel None
Type DateTime

EmailReminderText

Property Value
Description For internal use only.
DisplayName Email Reminder Text
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName emailremindertext
MaxLength 1250
RequiredLevel None
Type String

EmailReminderType

Property Value
Description Shows the type of the email reminder.
DisplayName Email Reminder Type
IsValidForForm False
IsValidForRead True
LogicalName emailremindertype
RequiredLevel None
Type Picklist

EmailReminderType Options

Value Label
0 If I do not receive a reply by
1 If the email is not opened by
2 Remind me anyways at

EmailSenderName

Property Value
Description Shows the name of the sender of the email.
DisplayName Email Sender Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName emailsendername
MaxLength 400
RequiredLevel None
Type String

EmailTrackingId

Property Value
Description Email Tracking Id.
DisplayName Email Tracking Id
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName emailtrackingid
RequiredLevel None
Type Uniqueidentifier

FollowEmailUserPreference

Property Value
Description Select whether the email allows following recipient activities sent from Microsoft Dynamics 365.This is user preference state which can be overridden by system evaluated state.
DisplayName Following
IsValidForForm True
IsValidForRead True
LogicalName followemailuserpreference
RequiredLevel None
Type Boolean

FollowEmailUserPreference Options

Value Label
1 True
0 False

DefaultValue: False

from

Property Value
Description Enter the sender of the email.
DisplayName From
IsValidForForm True
IsValidForRead True
LogicalName from
RequiredLevel None
Targets queue,systemuser
Type PartyList

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsBilled

Property Value
Description Information regarding whether the email activity was billed as part of resolving a case.
DisplayName Is Billed
IsValidForForm False
IsValidForRead True
LogicalName isbilled
RequiredLevel None
Type Boolean

IsBilled Options

Value Label
1 Yes
0 No

DefaultValue: False

IsWorkflowCreated

Property Value
Description Indication if the email was created by a workflow rule.
DisplayName Is Workflow Created
IsValidForForm False
IsValidForRead True
LogicalName isworkflowcreated
RequiredLevel None
Type Boolean

IsWorkflowCreated Options

Value Label
1 Yes
0 No

DefaultValue: False

LastOnHoldTime

Property Value
DateTimeBehavior UserLocal
Description Contains the date and time stamp of the last on hold time.
DisplayName Last On Hold Time
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName lastonholdtime
RequiredLevel None
Type DateTime

LastOpenedTime

Property Value
DateTimeBehavior UserLocal
Description Shows the latest date and time when email was opened.
DisplayName Last Opened Time
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName lastopenedtime
RequiredLevel None
Type DateTime

LinksClickedCount

Property Value
Description Shows the number of times a link in an email has been clicked.
DisplayName Links Clicked Count
Format None
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName linksclickedcount
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

MessageId

Property Value
Description Unique identifier of the email message. Used only for email that is received.
DisplayName Message ID
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName messageid
MaxLength 320
RequiredLevel None
Type String

MessageIdDupCheck

Property Value
Description For internal use only.
DisplayName Message ID Dup Check
IsValidForForm False
IsValidForRead False
LogicalName messageiddupcheck
RequiredLevel SystemRequired
Type Uniqueidentifier

MimeType

Property Value
Description MIME type of the email message data.
DisplayName Mime Type
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName mimetype
MaxLength 256
RequiredLevel None
Type String

Notifications

Property Value
Description Select the notification code to identify issues with the email recipients or attachments, such as blocked attachments.
DisplayName Notifications
IsValidForForm True
IsValidForRead True
LogicalName notifications
RequiredLevel None
Type Picklist

Notifications Options

Value Label
0 None
1 The message was saved as a Microsoft Dynamics 365 email record, but not all the attachments could be saved with it. An attachment cannot be saved if it is blocked or if its file type is invalid.
2 Truncated body.

OpenCount

Property Value
Description Shows the number of times an email has been opened.
DisplayName Open Count
Format None
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName opencount
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Property Value
Description Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

ParentActivityId

Property Value
Description Select the activity that the email is associated with.
DisplayName Parent Activity Id
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName parentactivityid
RequiredLevel None
Targets email
Type Lookup

PriorityCode

Property Value
Description Select the priority so that preferred customers or critical issues are handled quickly.
DisplayName Priority
IsValidForForm True
IsValidForRead True
LogicalName prioritycode
RequiredLevel None
Type Picklist

PriorityCode Options

Value Label
0 Low
1 Normal
2 High

ProcessId

Property Value
Description Shows the ID of the process.
DisplayName Process
IsValidForForm False
IsValidForRead True
LogicalName processid
RequiredLevel None
Type Uniqueidentifier

ReadReceiptRequested

Property Value
Description Indicates that a read receipt is requested.
DisplayName Read Receipt Requested
IsValidForForm False
IsValidForRead True
LogicalName readreceiptrequested
RequiredLevel None
Type Boolean

ReadReceiptRequested Options

Value Label
1 Yes
0 No

DefaultValue: False

RegardingObjectId

Property Value
Description Choose the record that the email relates to.
DisplayName Regarding
IsValidForForm True
IsValidForRead True
LogicalName regardingobjectid
RequiredLevel None
Targets account,asyncoperation,contact,knowledgearticle,knowledgebaserecord
Type Lookup

RegardingObjectTypeCode

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName regardingobjecttypecode
RequiredLevel None
Type EntityName

ReminderActionCardId

Property Value
Description Reminder Action Card Id.
DisplayName Reminder Action Card Id.
IsValidForForm False
IsValidForRead True
LogicalName reminderactioncardid
RequiredLevel None
Type Uniqueidentifier

ScheduledEnd

Property Value
DateTimeBehavior UserLocal
Description Enter the expected due date and time for the activity to be completed to provide details about when the email will be sent.
DisplayName Due Date
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName scheduledend
RequiredLevel None
Type DateTime

ScheduledStart

Property Value
DateTimeBehavior UserLocal
Description Enter the expected start date and time for the activity to provide details about the tentative time when the email activity must be initiated.
DisplayName Start Date
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName scheduledstart
RequiredLevel None
Type DateTime

Sender

Property Value
Description Sender of the email.
DisplayName From
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName sender
MaxLength 250
RequiredLevel None
Type String

SendersAccountName

Property Value
Description Shows the name of the sender account of the email.
DisplayName Email Sender Account Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName sendersaccountname
MaxLength 400
RequiredLevel None
Type String

SLAId

Property Value
Description Choose the service level agreement (SLA) that you want to apply to the email record.
DisplayName SLA
IsValidForForm True
IsValidForRead True
LogicalName slaid
RequiredLevel None
Targets sla
Type Lookup

SortDate

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time by which the activities are sorted.
DisplayName Sort Date
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName sortdate
RequiredLevel None
Type DateTime

StageId

Property Value
Description Shows the ID of the stage.
DisplayName (Deprecated) Process Stage
IsValidForForm False
IsValidForRead True
LogicalName stageid
RequiredLevel None
Type Uniqueidentifier

StateCode

Property Value
Description Shows whether the email is open, completed, or canceled. Completed and canceled email is read-only and can't be edited.
DisplayName Activity Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Open 1 Open
1 Completed 2 Completed
2 Canceled 5 Canceled

StatusCode

Property Value
Description Select the email's status.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
1 Draft 0
2 Completed 1
3 Sent 1
4 Received 1
5 Canceled 2
6 Pending Send 1
7 Sending 1
8 Failed 0

Subcategory

Property Value
Description Type a subcategory to identify the email type and relate the activity to a specific product, sales region, business group, or other function.
DisplayName Sub-Category
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName subcategory
MaxLength 250
RequiredLevel None
Type String

Subject

Property Value
Description Type a short description about the objective or primary topic of the email.
DisplayName Subject
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName subject
MaxLength 400
RequiredLevel None
Type String

SubmittedBy

Property Value
Description Shows the Microsoft Office Outlook account for the user who submitted the email to Microsoft Dynamics 365.
DisplayName Submitted By
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName submittedby
MaxLength 250
RequiredLevel None
Type String

TemplateId

Property Value
Description For internal use only. ID for template used in email.
DisplayName ID for template used.
IsValidForForm False
IsValidForRead True
LogicalName templateid
RequiredLevel None
Targets template
Type Lookup

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

to

Property Value
Description Enter the account, contact, lead, queue, or user recipients for the email.
DisplayName To
IsValidForForm True
IsValidForRead True
LogicalName to
RequiredLevel None
Targets account,contact,knowledgearticle,queue,systemuser,unresolvedaddress
Type PartyList

ToRecipients

Property Value
Description Shows the email addresses corresponding to the recipients.
DisplayName To Recipients
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName torecipients
MaxLength 500
RequiredLevel None
Type String

TrackingToken

Property Value
Description Shows the tracking token assigned to the email to make sure responses are automatically tracked in Microsoft Dynamics 365.
DisplayName Tracking Token
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName trackingtoken
MaxLength 50
RequiredLevel None
Type String

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

TraversedPath

Property Value
Description For internal use only.
DisplayName (Deprecated) Traversed Path
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName traversedpath
MaxLength 1250
RequiredLevel None
Type String

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ActivityTypeCode

Property Value
Description Shows the type of activity.
DisplayName Activity Type
IsValidForForm False
IsValidForRead True
LogicalName activitytypecode
RequiredLevel SystemRequired
Type EntityName

AttachmentCount

Property Value
Description Shows the umber of attachments of the email message.
DisplayName Attachment Count
Format None
IsValidForForm False
IsValidForRead True
LogicalName attachmentcount
MaxValue 2147483647
MinValue 0
RequiredLevel SystemRequired
Type Integer

Compressed

Property Value
Description Indicates if the body is compressed.
DisplayName Compression
IsValidForForm False
IsValidForRead True
LogicalName compressed
RequiredLevel SystemRequired
Type Boolean

Compressed Options

Value Label
1 Compressed
0 Not compressed

DefaultValue: False

ConversationIndex

Property Value
Description Identifier for all the email responses for this conversation.
DisplayName Conversation Index
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName conversationindex
MaxLength 2048
RequiredLevel None
Type String

CorrelationMethod

Property Value
Description Shows how an email is matched to an existing email in Microsoft Dynamics 365. For system use only.
DisplayName Correlation Method
IsValidForForm False
IsValidForRead True
LogicalName correlationmethod
RequiredLevel None
Type Picklist

CorrelationMethod Options

Value Label
0 None
1 Skipped
2 XHeader
3 InReplyTo
4 TrackingToken
5 ConversationIndex
6 SmartMatching
7 CustomCorrelation

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

EmailReminderStatus

Property Value
Description Shows the status of the email reminder.
DisplayName Email Reminder Status
IsValidForForm False
IsValidForRead True
LogicalName emailreminderstatus
RequiredLevel SystemRequired
Type Picklist

EmailReminderStatus Options

Value Label
0 NotSet
1 ReminderSet
2 ReminderExpired
3 ReminderInvalid

EmailSender

Property Value
Description Shows the sender of the email.
DisplayName Sender
IsValidForForm False
IsValidForRead True
LogicalName emailsender
RequiredLevel None
Targets account,contact,queue,systemuser
Type Lookup

EmailSenderObjectTypeCode

Property Value
Description Shows the object type of sender of the email.
DisplayName Email Sender Type
IsValidForForm False
IsValidForRead True
LogicalName emailsenderobjecttypecode
RequiredLevel None
Type EntityName

EmailSenderYomiName

Property Value
Description Shows the yomi name of the email sender
DisplayName Email Sender yomi Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName emailsenderyominame
MaxLength 400
RequiredLevel None
Type String

ExchangeRate

Property Value
Description Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

InReplyTo

Property Value
Description Type the ID of the email message that this email activity is a response to.
DisplayName In Reply To Message
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName inreplyto
MaxLength 320
RequiredLevel None
Type String

IsEmailFollowed

Property Value
Description For internal use only. Shows whether this email is followed. This is evaluated state which overrides user selection of follow email.
DisplayName Followed
IsValidForForm False
IsValidForRead True
LogicalName isemailfollowed
RequiredLevel None
Type Boolean

IsEmailFollowed Options

Value Label
1 Yes
0 No

DefaultValue: False

IsEmailReminderSet

Property Value
Description For internal use only. Shows whether this email Reminder is Set.
DisplayName Reminder Set
IsValidForForm False
IsValidForRead True
LogicalName isemailreminderset
RequiredLevel None
Type Boolean

IsEmailReminderSet Options

Value Label
1 Yes
0 No

DefaultValue: False

IsRegularActivity

Property Value
Description Information regarding whether the activity is a regular activity type or event type.
DisplayName Is Regular Activity
IsValidForForm False
IsValidForRead True
LogicalName isregularactivity
RequiredLevel SystemRequired
Type Boolean

IsRegularActivity Options

Value Label
1 Yes
0 No

DefaultValue: False

IsUnsafe

Property Value
Description For internal use only.
DisplayName IsUnsafe
Format None
IsValidForForm False
IsValidForRead True
LogicalName isunsafe
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OnHoldTime

Property Value
Description Shows how long, in minutes, that the record was on hold.
DisplayName On Hold Time (Minutes)
Format None
IsValidForForm True
IsValidForRead True
LogicalName onholdtime
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

OwnerIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier of the business unit that owns the email activity.
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier of the team who owns the email activity.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier of the user who owns the email activity.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

ParentActivityIdName

Property Value
Description Parent Activity Name
DisplayName Parent Activity Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName parentactivityidname
MaxLength 400
RequiredLevel None
Type String

PostponeEmailProcessingUntil

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Delay email processing until
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName postponeemailprocessinguntil
RequiredLevel None
Type DateTime

RegardingObjectIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName regardingobjectidname
MaxLength 100
RequiredLevel None
Type String

RegardingObjectIdYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName regardingobjectidyominame
MaxLength 100
RequiredLevel None
Type String

ReplyCount

Property Value
Description Shows the number of replies received for an email.
DisplayName Reply Count
Format None
IsValidForForm False
IsValidForRead True
LogicalName replycount
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

SafeDescription

Property Value
Description Safe body text of the e-mail.
DisplayName Safe Description
Format Email
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName safedescription
MaxLength 1073741823
RequiredLevel None
Type Memo

ScheduledDurationMinutes

Property Value
Description Scheduled duration of the email activity, specified in minutes.
DisplayName Scheduled Duration
Format Duration
IsValidForForm False
IsValidForRead True
LogicalName scheduleddurationminutes
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

SenderMailboxId

Property Value
Description Select the mailbox associated with the sender of the email message.
DisplayName Sender's Mailbox
IsValidForForm False
IsValidForRead True
LogicalName sendermailboxid
RequiredLevel None
Targets mailbox
Type Lookup

SenderMailboxIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName sendermailboxidname
MaxLength 100
RequiredLevel None
Type String

SendersAccount

Property Value
Description Shows the parent account of the sender of the email.
DisplayName Senders Account
IsValidForForm False
IsValidForRead True
LogicalName sendersaccount
RequiredLevel None
Targets account
Type Lookup

SendersAccountObjectTypeCode

Property Value
Description Shows the parent account type code of the sender of the email.
DisplayName SendersAccount Type
IsValidForForm False
IsValidForRead True
LogicalName sendersaccountobjecttypecode
RequiredLevel None
Type EntityName

SendersAccountYomiName

Property Value
Description Shows the name of the sender account yomi name
DisplayName Email Sender Account yomi Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName sendersaccountyominame
MaxLength 400
RequiredLevel None
Type String

SentOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time that the email was sent.
DisplayName Date Sent
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName senton
RequiredLevel None
Type DateTime

SLAInvokedId

Property Value
Description Last SLA that was applied to this email. This field is for internal use only.
DisplayName Last SLA applied
IsValidForForm False
IsValidForRead True
LogicalName slainvokedid
RequiredLevel None
Targets sla
Type Lookup

SLAInvokedIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName slainvokedidname
MaxLength 100
RequiredLevel None
Type String

SLAName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName slaname
MaxLength 100
RequiredLevel None
Type String

TemplateIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName templateidname
MaxLength 100
RequiredLevel None
Type String

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Version number of the email message.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

email_actioncard

Same as actioncard entity email_actioncard Many-To-One relationship.

Property Value
ReferencingEntity actioncard
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName email_actioncard
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

email_activity_parties

Same as activityparty entity email_activity_parties Many-To-One relationship.

Property Value
ReferencingEntity activityparty
ReferencingAttribute activityid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName email_activity_parties
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Email_DuplicateMatchingRecord

Same as duplicaterecord entity Email_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Email_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Email_SyncErrors

Same as syncerror entity Email_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Email_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Email_DuplicateBaseRecord

Same as duplicaterecord entity Email_DuplicateBaseRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Email_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Email_AsyncOperations

Same as asyncoperation entity Email_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Email_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Email_ProcessSessions

Same as processsession entity Email_ProcessSessions Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Email_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

slakpiinstance_email

Same as slakpiinstance entity slakpiinstance_email Many-To-One relationship.

Property Value
ReferencingEntity slakpiinstance
ReferencingAttribute regarding
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName slakpiinstance_email
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Email_Annotation

Same as annotation entity Email_Annotation Many-To-One relationship.

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Email_Annotation
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

email_activity_mime_attachment

Same as activitymimeattachment entity email_activity_mime_attachment Many-To-One relationship.

Property Value
ReferencingEntity activitymimeattachment
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName email_activity_mime_attachment
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

email_email_parentactivityid

Same as email entity email_email_parentactivityid Many-To-One relationship.

Property Value
ReferencingEntity email
ReferencingAttribute parentactivityid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName email_email_parentactivityid
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

email_principalobjectattributeaccess

Same as principalobjectattributeaccess entity email_principalobjectattributeaccess Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName email_principalobjectattributeaccess
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Email_BulkDeleteFailures

Same as bulkdeletefailure entity Email_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Email_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

email_connections1

Same as connection entity email_connections1 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record1id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName email_connections1
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

email_connections2

Same as connection entity email_connections2 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record2id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName email_connections2
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Email_QueueItem

Same as queueitem entity Email_QueueItem Many-To-One relationship.

Property Value
ReferencingEntity queueitem
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Email_QueueItem
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

KnowledgeBaseRecord_Emails

See knowledgebaserecord Entity KnowledgeBaseRecord_Emails One-To-Many relationship.

lk_email_modifiedby

See systemuser Entity lk_email_modifiedby One-To-Many relationship.

Account_Email_SendersAccount

See account Entity Account_Email_SendersAccount One-To-Many relationship.

Email_EmailTemplate

See template Entity Email_EmailTemplate One-To-Many relationship.

Queue_Email_EmailSender

See queue Entity Queue_Email_EmailSender One-To-Many relationship.

Contact_Email_EmailSender

See contact Entity Contact_Email_EmailSender One-To-Many relationship.

Account_Email_EmailSender

See account Entity Account_Email_EmailSender One-To-Many relationship.

TransactionCurrency_Email

See transactioncurrency Entity TransactionCurrency_Email One-To-Many relationship.

Contact_Emails

See contact Entity Contact_Emails One-To-Many relationship.

user_email

See systemuser Entity user_email One-To-Many relationship.

SystemUser_Email_EmailSender

See systemuser Entity SystemUser_Email_EmailSender One-To-Many relationship.

AsyncOperation_Emails

See asyncoperation Entity AsyncOperation_Emails One-To-Many relationship.

lk_email_createdonbehalfby

See systemuser Entity lk_email_createdonbehalfby One-To-Many relationship.

KnowledgeArticle_Emails

See knowledgearticle Entity KnowledgeArticle_Emails One-To-Many relationship.

email_sendermailboxid_mailbox

See mailbox Entity email_sendermailboxid_mailbox One-To-Many relationship.

activity_pointer_email

See activitypointer Entity activity_pointer_email One-To-Many relationship.

lk_email_modifiedonbehalfby

See systemuser Entity lk_email_modifiedonbehalfby One-To-Many relationship.

team_email

See team Entity team_email One-To-Many relationship.

manualsla_email

See sla Entity manualsla_email One-To-Many relationship.

business_unit_email_activities

See businessunit Entity business_unit_email_activities One-To-Many relationship.

Account_Emails

See account Entity Account_Emails One-To-Many relationship.

email_email_parentactivityid

See email Entity email_email_parentactivityid One-To-Many relationship.

processstage_emails

See processstage Entity processstage_emails One-To-Many relationship.

sla_email

See sla Entity sla_email One-To-Many relationship.

lk_email_createdby

See systemuser Entity lk_email_createdby One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
email EntityType