email EntityType

Activity that is delivered using email protocols.

Entity Set Path
[organization URI]/api/data/v9.0/emails
Base Type
activitypointer
Display Name
Email
Primary Key
activityid
Primary Key Attribute
subject
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
activityadditionalparams Edm.String

Additional information provided by the external application as JSON. For internal use only.

Display Name: Additional Parameters

activityid Edm.Guid

Unique identifier of the activity.

Display Name: Email Message

activitytypecode Edm.String

Type of activity.

Display Name: Activity Type

Read Only
actualdurationminutes Edm.Int32

Actual duration of the activity in minutes.

Display Name: Duration

actualend Edm.DateTimeOffset

Actual end time of the activity.

Display Name: Actual End

actualstart Edm.DateTimeOffset

Actual start time of the activity.

Display Name: Actual Start

attachmentcount Edm.Int32

Shows the umber of attachments of the email message.

Display Name: Attachment Count

Read Only
attachmentopencount Edm.Int32

Shows the number of times an email attachment has been viewed.

Display Name: Attachment Open Count

baseconversationindexhash Edm.Int32

Hash of base of conversation index.

Display Name: Conversation Index (Hash)

category Edm.String

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.

Display Name: Category

community Edm.Int32

Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only.

compressed Edm.Boolean

Indicates if the body is compressed.

Display Name: Compression

Read Only
Default Options
Value Label
1 Compressed
0 Not compressed
conversationindex Edm.String

Identifier for all the email responses for this conversation.

Display Name: Conversation Index

Read Only
conversationtrackingid Edm.Guid

Conversation Tracking Id.

Display Name: Conversation Tracking Id

correlationmethod Edm.Int32

Shows how an email is matched to an existing email in Microsoft Dynamics 365. For system use only.

Display Name: Correlation Method

Read Only
Default Options
Value Label
0 None
1 Skipped
2 XHeader
3 InReplyTo
4 TrackingToken
5 ConversationIndex
6 SmartMatching
7 CustomCorrelation
createdon Edm.DateTimeOffset

Date and time when the activity was created.

Display Name: Created On

Read Only
delayedemailsendtime Edm.DateTimeOffset

Enter the expected date and time when email will be sent.

Display Name: Send Later

deliveryattempts Edm.Int32

Shows the count of the number of attempts made to send the email. The count is used as an indicator of email routing issues.

Display Name: No. of Delivery Attempts

deliverylastattemptedon Edm.DateTimeOffset

Date and time when the delivery of the activity was last attempted.

Read Only
deliveryprioritycode Edm.Int32

Priority of delivery of the activity to the email server.

Display Name: Delivery Priority

Default Options
Value Label
0 Low
1 Normal
2 High
deliveryreceiptrequested Edm.Boolean

Select whether the sender should receive confirmation that the email was delivered.

Display Name: Delivery Receipt Requested

Default Options
Value Label
1 Yes
0 No
description Edm.String

Description of the activity.

Display Name: Description

directioncode Edm.Boolean

Select the direction of the email as incoming or outbound.

Display Name: Direction

Default Options
Value Label
1 Outgoing
0 Incoming
emailreminderexpirytime Edm.DateTimeOffset

Shows the date and time when an email reminder expires.

Display Name: Email Reminder Expiry Time

emailreminderstatus Edm.Int32

Shows the status of the email reminder.

Display Name: Email Reminder Status

Read Only
Default Options
Value Label
0 NotSet
1 ReminderSet
2 ReminderExpired
3 ReminderInvalid
emailremindertext Edm.String

For internal use only.

Display Name: Email Reminder Text

emailremindertype Edm.Int32

Shows the type of the email reminder.

Display Name: Email Reminder Type

Default 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
emailtrackingid Edm.Guid

Email Tracking Id.

Display Name: Email Tracking Id

exchangeitemid Edm.String

The message id of activity which is returned from Exchange Server.

exchangerate Edm.Decimal

Exchange rate for the currency associated with the activitypointer with respect to the base currency.

Display Name: Exchange Rate

Read Only
exchangeweblink Edm.String

Shows the web link of Activity of type email.

followemailuserpreference Edm.Boolean

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.

Display Name: Following

Default Options
Value Label
1 True
0 False
importsequencenumber Edm.Int32

Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

inreplyto Edm.String

Type the ID of the email message that this email activity is a response to.

Display Name: In Reply To Message

Read Only
instancetypecode Edm.Int32

Type of instance of a recurring series.

Read Only
isbilled Edm.Boolean

Information regarding whether the activity was billed as part of resolving a case.

Display Name: Is Billed

Default Options
Value Label
1 Yes
0 No
isemailfollowed Edm.Boolean

For internal use only. Shows whether this email is followed. This is evaluated state which overrides user selection of follow email.

Display Name: Followed

Read Only
Default Options
Value Label
1 Yes
0 No
isemailreminderset Edm.Boolean

For internal use only. Shows whether this email Reminder is Set.

Display Name: Reminder Set

Read Only
Default Options
Value Label
1 Yes
0 No
ismapiprivate Edm.Boolean

For internal use only.

isregularactivity Edm.Boolean

Information regarding whether the activity is a regular activity type or event type.

Display Name: Is Regular Activity

Read Only
Default Options
Value Label
1 Yes
0 No
isunsafe Edm.Int32

For internal use only.

Display Name: IsUnsafe

Read Only
isworkflowcreated Edm.Boolean

Information regarding whether the activity was created from a workflow rule.

Display Name: Is Workflow Created

Default Options
Value Label
1 Yes
0 No
lastonholdtime Edm.DateTimeOffset

Contains the date and time stamp of the last on hold time.

Display Name: Last On Hold Time

lastopenedtime Edm.DateTimeOffset

Shows the latest date and time when email was opened.

Display Name: Last Opened Time

leftvoicemail Edm.Boolean

Left the voice mail

linksclickedcount Edm.Int32

Shows the number of times a link in an email has been clicked.

Display Name: Links Clicked Count

messageid Edm.String

Unique identifier of the email message. Used only for email that is received.

Display Name: Message ID

mimetype Edm.String

MIME type of the email message data.

Display Name: Mime Type

modifiedon Edm.DateTimeOffset

Date and time when activity was last modified.

Display Name: Modified On

Read Only
notifications Edm.Int32

Select the notification code to identify issues with the email recipients or attachments, such as blocked attachments.

Display Name: Notifications

Default 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.
onholdtime Edm.Int32

Shows how long, in minutes, that the record was on hold.

Display Name: On Hold Time (Minutes)

Read Only
opencount Edm.Int32

Shows the number of times an email has been opened.

Display Name: Open Count

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

postponeactivityprocessinguntil Edm.DateTimeOffset

For internal use only.

Read Only
postponeemailprocessinguntil Edm.DateTimeOffset

For internal use only.

Display Name: Delay email processing until

Read Only
prioritycode Edm.Int32

Priority of the activity.

Display Name: Priority

Default Options
Value Label
0 Low
1 Normal
2 High
processid Edm.Guid

Unique identifier of the Process.

Display Name: Process

readreceiptrequested Edm.Boolean

Indicates that a read receipt is requested.

Display Name: Read Receipt Requested

Default Options
Value Label
1 Yes
0 No
reminderactioncardid Edm.Guid

Reminder Action Card Id.

Display Name: Reminder Action Card Id.

replycount Edm.Int32

Shows the number of replies received for an email.

Display Name: Reply Count

Read Only
reservedforinternaluse Edm.String

For internal use only

Display Name: Reserved for internal use

safedescription Edm.String

Safe body text of the e-mail.

Display Name: Safe Description

Read Only
scheduleddurationminutes Edm.Int32

Scheduled duration of the activity, specified in minutes.

Display Name: Scheduled Duration

scheduledend Edm.DateTimeOffset

Scheduled end time of the activity.

Display Name: Due Date

scheduledstart Edm.DateTimeOffset

Scheduled start time of the activity.

Display Name: Start Date

sender Edm.String

Sender of the email.

Display Name: From

senton Edm.DateTimeOffset

Date and time when the activity was sent.

Display Name: Date Sent

Read Only
seriesid Edm.Guid

Uniqueidentifier specifying the id of recurring series of an instance.

Read Only
sortdate Edm.DateTimeOffset

Shows the date and time by which the activities are sorted.

Display Name: Sort Date

stageid Edm.Guid

Unique identifier of the Stage.

Display Name: (Deprecated) Process Stage

statecode Edm.Int32

Status of the activity.

Display Name: Activity Status

Default Options
Value Label
0 Open
1 Completed
2 Canceled
statuscode Edm.Int32

Reason for the status of the activity.

Display Name: Status Reason

Default Options
Value Label
1 Draft
2 Completed
3 Sent
4 Received
5 Canceled
6 Pending Send
7 Sending
8 Failed
subcategory Edm.String

Type a subcategory to identify the email type and relate the activity to a specific product, sales region, business group, or other function.

Display Name: Sub-Category

subject Edm.String

Subject associated with the activity.

Display Name: Subject

submittedby Edm.String

Shows the Microsoft Office Outlook account for the user who submitted the email to Microsoft Dynamics 365.

Display Name: Submitted By

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

torecipients Edm.String

Shows the email addresses corresponding to the recipients.

Display Name: To Recipients

trackingtoken Edm.String

Shows the tracking token assigned to the email to make sure responses are automatically tracked in Microsoft Dynamics 365.

Display Name: Tracking Token

traversedpath Edm.String

For internal use only.

Display Name: (Deprecated) Traversed Path

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version number of the activity.

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_acceptingentityid_value acceptingentityid

The Entity that Accepted the Email

_correlatedactivityid_value acceptingentityid

Correlated Activity Id

_createdby_value acceptingentityid

Unique identifier of the user who created the activity.

_createdonbehalfby_value acceptingentityid

Unique identifier of the delegate user who created the activitypointer.

_emailsender_value emailsender_accountemailsender_contactemailsender_queueemailsender_systemuser

Shows the sender of the email.

_modifiedby_value acceptingentityid

Unique identifier of user who last modified the activity.

_modifiedonbehalfby_value acceptingentityid

Unique identifier of the delegate user who last modified the activitypointer.

_ownerid_value acceptingentityid

Unique identifier of the user or team who owns the activity.

_owningbusinessunit_value acceptingentityid

Unique identifier of the business unit that owns the activity.

_owningteam_value acceptingentityid

Unique identifier of the team that owns the activity.

_owninguser_value acceptingentityid

Unique identifier of the user that owns the activity.

_parentactivityid_value acceptingentityid

Select the activity that the email is associated with.

_receivingmailboxid_value ReceivingMailboxId_Email

The Mailbox that Received the Email.

_regardingobjectid_value acceptingentityid

Unique identifier of the object with which the activity is associated.

_sendermailboxid_value acceptingentityid

Unique identifier of the mailbox associated with the sender of the email message.

_sendersaccount_value sendersaccount

Shows the parent account of the sender of the email.

_slaid_value acceptingentityid

Choose the service level agreement (SLA) that you want to apply to the case record.

_slainvokedid_value acceptingentityid

Last SLA that was applied to this case. This field is for internal use only.

_templateid_value templateid

For internal use only. ID for template used in email.

_transactioncurrencyid_value acceptingentityid

Unique identifier of the currency associated with the activitypointer.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
acceptingentityid queue email_acceptingentity_queue
activityid_activitypointer activitypointer activity_pointer_email
CorrelatedActivityId_Email email email_email_CorrelatedActivityId
createdby systemuser lk_activitypointer_createdby
createdby_email systemuser lk_email_createdby
createdonbehalfby systemuser lk_activitypointer_createdonbehalfby
createdonbehalfby_email systemuser lk_email_createdonbehalfby
emailsender_account account Account_Email_EmailSender
emailsender_contact contact Contact_Email_EmailSender
emailsender_queue queue Queue_Email_EmailSender
emailsender_systemuser systemuser SystemUser_Email_EmailSender
modifiedby systemuser lk_activitypointer_modifiedby
modifiedby_email systemuser lk_email_modifiedby
modifiedonbehalfby systemuser lk_activitypointer_modifiedonbehalfby
modifiedonbehalfby_email systemuser lk_email_modifiedonbehalfby
ownerid principal owner_activitypointers
ownerid_email principal owner_emails
owningbusinessunit businessunit business_unit_activitypointer
owningbusinessunit_email businessunit business_unit_email_activities
owningteam team team_activity
owningteam_email team team_email
owninguser systemuser user_activity
owninguser_email systemuser user_email
parentactivityid email email_email_parentactivityid
ReceivingMailboxId_Email mailbox mailbox_email_ReceivingMailboxId
regardingobjectid_account account Account_ActivityPointers
regardingobjectid_account_email account Account_Emails
regardingobjectid_asyncoperation asyncoperation AsyncOperation_Emails
regardingobjectid_contact contact Contact_ActivityPointers
regardingobjectid_contact_email contact Contact_Emails
regardingobjectid_knowledgearticle knowledgearticle KnowledgeArticle_ActivityPointers
regardingobjectid_knowledgearticle_email knowledgearticle KnowledgeArticle_Emails
regardingobjectid_knowledgebaserecord knowledgebaserecord KnowledgeBaseRecord_ActivityPointers
regardingobjectid_knowledgebaserecord_email knowledgebaserecord KnowledgeBaseRecord_Emails
regardingobjectid_new_interactionforemail interactionforemail new_interactionforemail_ActivityPointers
sendermailboxid mailbox activitypointer_sendermailboxid_mailbox
sendermailboxid_email mailbox email_sendermailboxid_mailbox
sendersaccount account Account_Email_SendersAccount
sla_activitypointer_sla sla manualsla_activitypointer
sla_email_sla sla manualsla_email
slainvokedid_activitypointer_sla sla sla_activitypointer
slainvokedid_email_sla sla sla_email
stageid_processstage processstage processstage_emails
templateid template Email_EmailTemplate
transactioncurrencyid transactioncurrency TransactionCurrency_ActivityPointer
transactioncurrencyid_email transactioncurrency TransactionCurrency_Email

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
activity_pointer_activity_mime_attachment activitymimeattachment objectid_activitypointer
activity_pointer_appointment appointment activityid_activitypointer
activity_pointer_chat chat activityid_chat
activity_pointer_email email activityid_activitypointer
activity_pointer_fax fax activityid_activitypointer
activity_pointer_letter letter activityid_activitypointer
activity_pointer_phonecall phonecall activityid_activitypointer
activity_pointer_recurrencerule recurrencerule objectid
activity_pointer_recurringappointmentmaster recurringappointmentmaster activityid_activitypointer
activity_pointer_socialactivity socialactivity activityid_activitypointer
activity_pointer_task task activityid_activitypointer
activitypointer_activity_parties activityparty activityid_activitypointer
ActivityPointer_AsyncOperations asyncoperation regardingobjectid_activitypointer
ActivityPointer_BulkDeleteFailures bulkdeletefailure regardingobjectid_activitypointer
activitypointer_connections1 connection record1id_activitypointer
activitypointer_connections2 connection record2id_activitypointer
ActivityPointer_QueueItem queueitem objectid_activitypointer
email_actioncard actioncard regardingobjectid_email_actioncard
email_activity_mime_attachment activitymimeattachment objectid_email
email_activity_parties activityparty activityid_email
Email_Annotation annotation objectid_email
Email_AsyncOperations asyncoperation regardingobjectid_email
Email_BulkDeleteFailures bulkdeletefailure regardingobjectid_email
email_connections1 connection record1id_email
email_connections2 connection record2id_email
Email_DuplicateBaseRecord duplicaterecord baserecordid_email
Email_DuplicateMatchingRecord duplicaterecord duplicaterecordid_email
email_email_CorrelatedActivityId email CorrelatedActivityId_Email
email_email_parentactivityid email parentactivityid
email_principalobjectattributeaccess principalobjectattributeaccess objectid_email
Email_ProcessSessions processsession regardingobjectid_email
Email_QueueItem queueitem objectid_email
Email_SyncErrors syncerror regardingobjectid_email_syncerror
slakpiinstance_activitypointer slakpiinstance regarding_activitypointer
slakpiinstance_email slakpiinstance regarding_email

Operations

The following operations can be used with the email entity type.

Name Binding
BackgroundSendEmail Not Bound
CheckIncomingEmail Not Bound
CheckPromoteEmail Not Bound
DeliverImmediatePromoteEmail Entity
DeliverIncomingEmail Collection
DeliverPromoteEmail Entity
GetTrackingTokenEmail Not Bound
GrantAccess Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
SendEmail Entity
SendEmailFromTemplate Not Bound
SendFax Not Bound
SendTemplate Not Bound

Solutions

The following solutions include the email entity type.

Name Description
System Solution Internal CRM System Solution
Second Patch for Application Common For internal use only.
Activities Patch Patch for Dynamics 365 workload for activities.
Application Common For internal use only.
Knowledge Management Features Dynamics 365 features and migrated controls for knowledge management.
Activities Dynamics 365 workload for activities.
msft_ActivitiesInfra_Extensions

See also