email EntityType
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Description: Activity that is delivered using email protocols.
Entity Set path:[organization URI]/api/data/v8.2/emails
Base Type: activitypointer EntityType
Display Name: Email
Primary Key: activityid
Primary Name Attribute: subject
Single-valued navigation properties
Properties represent fields of data stored in the entity. Some properties are read-only.
Name | Type | Details |
|---|---|---|
activityadditionalparams | Edm.String | Description: Additional information provided by the external application as JSON. For internal use only. Display Name: Additional Parameters Inherited from: activitypointer EntityType |
activityid | Edm.Guid | Description: Unique identifier of the activity. Display Name: Email Message Inherited from: activitypointer EntityType |
activitytypecode | Edm.String | Description: Type of activity. Display Name: Activity Type Read-only property Inherited from: activitypointer EntityType |
actualdurationminutes | Edm.Int32 | Description: Actual duration of the activity in minutes. Display Name: Duration Inherited from: activitypointer EntityType |
actualend | Edm.DateTimeOffset | Description: Actual end time of the activity. Display Name: Actual End Inherited from: activitypointer EntityType |
actualstart | Edm.DateTimeOffset | Description: Actual start time of the activity. Display Name: Actual Start Inherited from: activitypointer EntityType |
attachmentcount | Edm.Int32 | Description: Shows the umber of attachments of the email message. Display Name: Attachment Count Read-only property |
attachmentopencount | Edm.Int32 | Description: Shows the number of times an email attachment has been viewed. Display Name: Attachment View Count |
baseconversationindexhash | Edm.Int32 | Description: Hash of base of conversation index. Display Name: Conversation Index (Hash) |
category | Edm.String | 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. Display Name: Category |
community | Edm.Int32 | Description: Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only. Inherited from: activitypointer EntityType |
compressed | Edm.Boolean | Description: Indicates if the body is compressed. Default Options: 1 : Compressed Display Name: Compression Read-only property |
conversationindex | Edm.String | Description: Identifier for all the email responses for this conversation. Display Name: Conversation Index Read-only property |
conversationtrackingid | Edm.Guid | Description: Conversation Tracking Id. Display Name: Conversation Tracking Id |
correlationmethod | Edm.Int32 | Description: Shows how an email is matched to an existing email in Microsoft Dynamics 365. For system use only. Default Options: 0 : None Display Name: Correlation Method Read-only property |
createdon | Edm.DateTimeOffset | Description: Date and time when the activity was created. Display Name: Created On Read-only property Inherited from: activitypointer EntityType |
delayedemailsendtime | Edm.DateTimeOffset | Description: Enter the expected date and time when email will be sent. Display Name: Delay Send |
deliveryattempts | Edm.Int32 | 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. Display Name: No. of Delivery Attempts |
deliverylastattemptedon | Edm.DateTimeOffset | Description: Date and time when the delivery of the activity was last attempted. Read-only property Inherited from: activitypointer EntityType |
deliveryprioritycode | Edm.Int32 | Description: Priority of delivery of the activity to the email server. Default Options: 0 : Low Display Name: Delivery Priority Inherited from: activitypointer EntityType |
deliveryreceiptrequested | Edm.Boolean | Description: Select whether the sender should receive confirmation that the email was delivered. Default Options: 1 : Yes Display Name: Delivery Receipt Requested |
description | Edm.String | Description: Description of the activity. Display Name: Description Inherited from: activitypointer EntityType |
directioncode | Edm.Boolean | Description: Select the direction of the email as incoming or outbound. Default Options: 1 : Outgoing Display Name: Direction |
emailreminderexpirytime | Edm.DateTimeOffset | Description: Shows the date and time when an email reminder expires. Display Name: Email Reminder Expiry Time |
emailreminderstatus | Edm.Int32 | Description: Shows the status of the email reminder. Default Options: 0 : NotSet Display Name: Email Reminder Status Read-only property |
emailremindertext | Edm.String | Description: For internal use only. Display Name: Email Reminder Text |
emailremindertype | Edm.Int32 | Description: Shows the type of the email reminder. Default Options: 0 : If I do not receive a reply by Display Name: Email Reminder Type |
emailtrackingid | Edm.Guid | Description: Email Tracking Id. Display Name: Email Tracking Id |
exchangeitemid | Edm.String | Description: The message id of activity which is returned from Exchange Server. Inherited from: activitypointer EntityType |
exchangerate | Edm.Decimal | Description: Exchange rate for the currency associated with the activitypointer with respect to the base currency. Display Name: Exchange Rate Read-only property Inherited from: activitypointer EntityType |
exchangeweblink | Edm.String | Description: Shows the web link of Activity of type email. Inherited from: activitypointer EntityType |
followemailuserpreference | Edm.Boolean | 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. Default Options: 1 : True Display Name: Following |
importsequencenumber | Edm.Int32 | Description: Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
inreplyto | Edm.String | Description: Type the ID of the email message that this email activity is a response to. Display Name: In Reply To Message Read-only property |
instancetypecode | Edm.Int32 | Description: Type of instance of a recurring series. Read-only property Inherited from: activitypointer EntityType |
isbilled | Edm.Boolean | Description: Information regarding whether the activity was billed as part of resolving a case. Default Options: 1 : Yes Display Name: Is Billed Inherited from: activitypointer EntityType |
isemailfollowed | Edm.Boolean | Description: For internal use only. Shows whether this email is followed. This is evaluated state which overrides user selection of follow email. Default Options: 1 : Yes Display Name: Followed Read-only property |
ismapiprivate | Edm.Boolean | Description: For internal use only. Inherited from: activitypointer EntityType |
isregularactivity | Edm.Boolean | Description: Information regarding whether the activity is a regular activity type or event type. Default Options: 1 : Yes Display Name: Is Regular Activity Read-only property Inherited from: activitypointer EntityType |
isunsafe | Edm.Int32 | Description: For internal use only. Display Name: IsUnsafe Read-only property |
isworkflowcreated | Edm.Boolean | Description: Information regarding whether the activity was created from a workflow rule. Default Options: 1 : Yes Display Name: Is Workflow Created Inherited from: activitypointer EntityType |
lastonholdtime | Edm.DateTimeOffset | Description: Contains the date and time stamp of the last on hold time. Display Name: Last On Hold Time Inherited from: activitypointer EntityType |
lastopenedtime | Edm.DateTimeOffset | Description: Shows the date and time when an email was last opened. Display Name: Last Opened Time |
leftvoicemail | Edm.Boolean | Description: Left the voice mail Inherited from: activitypointer EntityType |
linksclickedcount | Edm.Int32 | Description: Shows the number of times a link in an email has been clicked. Display Name: Link Click Count |
messageid | Edm.String | Description: Unique identifier of the email message. Used only for email that is received. Display Name: Message ID |
mimetype | Edm.String | Description: MIME type of the email message data. Display Name: Mime Type |
modifiedon | Edm.DateTimeOffset | Description: Date and time when activity was last modified. Display Name: Modified On Read-only property Inherited from: activitypointer EntityType |
notifications | Edm.Int32 | Description: Select the notification code to identify issues with the email recipients or attachments, such as blocked attachments. Default Options: 0 : None Display Name: Notifications |
onholdtime | Edm.Int32 | Description: Shows how long, in minutes, that the record was on hold. Display Name: On Hold Time (Minutes) Read-only property Inherited from: activitypointer EntityType |
opencount | Edm.Int32 | Description: Shows the number of times an email has been opened. Display Name: Open Count |
overriddencreatedon | Edm.DateTimeOffset | Description: Date and time that the record was migrated. Display Name: Record Created On |
postponeactivityprocessinguntil | Edm.DateTimeOffset | Description: For internal use only. Read-only property Inherited from: activitypointer EntityType |
postponeemailprocessinguntil | Edm.DateTimeOffset | Description: For internal use only. Display Name: Delay email processing until Read-only property |
prioritycode | Edm.Int32 | Description: Priority of the activity. Default Options: 0 : Low Display Name: Priority Inherited from: activitypointer EntityType |
processid | Edm.Guid | Description: Unique identifier of the Process. Display Name: Process Inherited from: activitypointer EntityType |
readreceiptrequested | Edm.Boolean | Description: Indicates that a read receipt is requested. Default Options: 1 : Yes Display Name: Read Receipt Requested |
reminderactioncardid | Edm.Guid | Description: Reminder Action Card ID. Display Name: Reminder Action Card Id. |
replycount | Edm.Int32 | Description: Shows the number of replies received for an email. Display Name: Reply Count Read-only property |
scheduleddurationminutes | Edm.Int32 | Description: Scheduled duration of the activity, specified in minutes. Display Name: Scheduled Duration Inherited from: activitypointer EntityType |
scheduledend | Edm.DateTimeOffset | Description: Scheduled end time of the activity. Display Name: Due Date Inherited from: activitypointer EntityType |
scheduledstart | Edm.DateTimeOffset | Description: Scheduled start time of the activity. Display Name: Start Date Inherited from: activitypointer EntityType |
sender | Edm.String | Description: Sender of the email. Display Name: From |
senton | Edm.DateTimeOffset | Description: Date and time when the activity was sent. Display Name: Date Sent Read-only property Inherited from: activitypointer EntityType |
seriesid | Edm.Guid | Description: Uniqueidentifier specifying the id of recurring series of an instance. Read-only property Inherited from: activitypointer EntityType |
sortdate | Edm.DateTimeOffset | Description: Shows the date and time by which the activities are sorted. Display Name: Sort Date Inherited from: activitypointer EntityType |
stageid | Edm.Guid | Description: Unique identifier of the Stage. Display Name: Process Stage Inherited from: activitypointer EntityType |
statecode | Edm.Int32 | Description: Status of the activity. Default Options: 0 : Open Display Name: Activity Status Inherited from: activitypointer EntityType |
statuscode | Edm.Int32 | Description: Reason for the status of the activity. Default Options: 1 : Draft Display Name: Status Reason Inherited from: activitypointer EntityType |
subcategory | Edm.String | Description: 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 | Description: Subject associated with the activity. Display Name: Subject Inherited from: activitypointer EntityType |
submittedby | Edm.String | Description: Shows the Microsoft Office Outlook account for the user who submitted the email to Microsoft Dynamics 365. Display Name: Submitted By |
timezoneruleversionnumber | Edm.Int32 | Description: For internal use only. Display Name: Time Zone Rule Version Number Inherited from: activitypointer EntityType |
torecipients | Edm.String | Description: Shows the email addresses corresponding to the recipients. Display Name: To Recipients |
trackingtoken | Edm.String | Description: 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 | Description: For internal use only. Display Name: Traversed Path Inherited from: activitypointer EntityType |
utcconversiontimezonecode | Edm.Int32 | Description: Time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code Inherited from: activitypointer EntityType |
versionnumber | Edm.Int64 | Description: Version number of the activity. Display Name: Version Number Read-only property Inherited from: activitypointer EntityType |
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 |
|---|---|---|
_createdby_value | Unique identifier of the user who created the activity. | |
_createdonbehalfby_value | Unique identifier of the delegate user who created the activitypointer. | |
_emailsender_value | emailsender_account emailsender_lead emailsender_contact emailsender_queue emailsender_equipment emailsender_systemuser | Shows the sender of the email. |
_modifiedby_value | Unique identifier of user who last modified the activity. | |
_modifiedonbehalfby_value | Unique identifier of the delegate user who last modified the activitypointer. | |
_ownerid_value | Unique identifier of the user or team who owns the activity. | |
_owningbusinessunit_value | Unique identifier of the business unit that owns the activity. | |
_owningteam_value | Unique identifier of the team that owns the activity. | |
_owninguser_value | Unique identifier of the user that owns the activity. | |
_parentactivityid_value | Select the activity that the email is associated with. | |
_regardingobjectid_value | Unique identifier of the object with which the activity is associated. | |
_sendermailboxid_value | 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. |
_serviceid_value | Unique identifier of an associated service. | |
_slaid_value | Choose the service level agreement (SLA) that you want to apply to the case record. | |
_slainvokedid_value | 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 | Unique identifier of the currency associated with the activitypointer. |
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 |
|---|---|---|
activityid_activitypointer | activity_pointer_email | |
createdby | lk_activitypointer_createdby | |
createdby_email | lk_email_createdby | |
createdonbehalfby | lk_activitypointer_createdonbehalfby | |
createdonbehalfby_email | lk_email_createdonbehalfby | |
emailsender_account | Account_Email_EmailSender | |
emailsender_contact | Contact_Email_EmailSender | |
emailsender_equipment | Equipment_Email_EmailSender | |
emailsender_lead | Lead_Email_EmailSender | |
emailsender_queue | Queue_Email_EmailSender | |
emailsender_systemuser | SystemUser_Email_EmailSender | |
modifiedby | lk_activitypointer_modifiedby | |
modifiedby_email | lk_email_modifiedby | |
modifiedonbehalfby | lk_activitypointer_modifiedonbehalfby | |
modifiedonbehalfby_email | lk_email_modifiedonbehalfby | |
ownerid | owner_activitypointers | |
owningbusinessunit | business_unit_activitypointer | |
owningbusinessunit_email | business_unit_email_activities | |
owningteam | team_activity | |
owningteam_email | team_email | |
owninguser | user_activity | |
owninguser_email | user_email | |
parentactivityid | email_email_parentactivityid | |
regardingobjectid_account | Account_ActivityPointers | |
regardingobjectid_account_email | Account_Emails | |
regardingobjectid_asyncoperation | AsyncOperation_Emails | |
regardingobjectid_bookableresourcebooking | bookableresourcebooking_ActivityPointers | |
regardingobjectid_bookableresourcebooking_email | bookableresourcebooking_Emails | |
regardingobjectid_bookableresourcebookingheader | bookableresourcebookingheader_ActivityPointers | |
regardingobjectid_bookableresourcebookingheader_email | bookableresourcebookingheader_Emails | |
regardingobjectid_bulkoperation | BulkOperation_ActivityPointers | |
regardingobjectid_bulkoperation_email | BulkOperation_Email | |
regardingobjectid_campaign | Campaign_ActivityPointers | |
regardingobjectid_campaign_email | Campaign_Emails | |
regardingobjectid_campaignactivity | CampaignActivity_ActivityPointers | |
regardingobjectid_campaignactivity_email | CampaignActivity_Emails | |
regardingobjectid_contact | Contact_ActivityPointers | |
regardingobjectid_contact_email | Contact_Emails | |
regardingobjectid_contract | Contract_ActivityPointers | |
regardingobjectid_contract_email | Contract_Emails | |
regardingobjectid_entitlement | entitlement_ActivityPointers | |
regardingobjectid_entitlement_email | entitlement_Emails | |
regardingobjectid_entitlementtemplate | entitlementtemplate_ActivityPointers | |
regardingobjectid_entitlementtemplate_email | entitlementtemplate_Emails | |
regardingobjectid_incident | Incident_ActivityPointers | |
regardingobjectid_incident_email | Incident_Emails | |
regardingobjectid_invoice | Invoice_ActivityPointers | |
regardingobjectid_invoice_email | Invoice_Emails | |
regardingobjectid_knowledgearticle | KnowledgeArticle_ActivityPointers | |
regardingobjectid_knowledgearticle_email | KnowledgeArticle_Emails | |
regardingobjectid_knowledgebaserecord | KnowledgeBaseRecord_ActivityPointers | |
regardingobjectid_knowledgebaserecord_email | KnowledgeBaseRecord_Emails | |
regardingobjectid_lead | Lead_ActivityPointers | |
regardingobjectid_lead_email | Lead_Emails | |
regardingobjectid_new_interactionforemail | new_interactionforemail_ActivityPointers | |
regardingobjectid_opportunity | Opportunity_ActivityPointers | |
regardingobjectid_opportunity_email | Opportunity_Emails | |
regardingobjectid_quote | Quote_ActivityPointers | |
regardingobjectid_quote_email | Quote_Emails | |
regardingobjectid_salesorder | SalesOrder_ActivityPointers | |
regardingobjectid_salesorder_email | SalesOrder_Emails | |
sendermailboxid | activitypointer_sendermailboxid_mailbox | |
sendermailboxid_email | email_sendermailboxid_mailbox | |
sendersaccount | Account_Email_SendersAccount | |
serviceid | service_activity_pointers | |
serviceid_email | service_emails | |
sla_activitypointer_sla | manualsla_activitypointer | |
sla_email_sla | manualsla_email | |
slainvokedid_activitypointer_sla | sla_activitypointer | |
slainvokedid_email_sla | sla_email | |
stageid_processstage | processstage_emails | |
templateid | Email_EmailTemplate | |
transactioncurrencyid | TransactionCurrency_ActivityPointer | |
transactioncurrencyid_email | TransactionCurrency_Email |
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_campaignresponse | originatingactivityid_activitypointer | |
activity_pointer_activity_mime_attachment | objectid_activitypointer | |
activity_pointer_appointment | activityid_activitypointer | |
activity_pointer_BulkOperation | activityid_activitypointer | |
activity_pointer_BulkOperation_logs | bulkoperationid_activitypointer | |
activity_pointer_campaignactivity | activityid_activitypointer | |
activity_pointer_campaignresponse | activityid_activitypointer | |
activity_pointer_email | activityid_activitypointer | |
activity_pointer_fax | activityid_activitypointer | |
activity_pointer_incident_resolution | activityid_activitypointer | |
activity_pointer_letter | activityid_activitypointer | |
activity_pointer_opportunity_close | activityid_activitypointer | |
activity_pointer_order_close | activityid_activitypointer | |
activity_pointer_phonecall | activityid_activitypointer | |
activity_pointer_quote_close | activityid_activitypointer | |
activity_pointer_recurringappointmentmaster | activityid_activitypointer | |
activity_pointer_service_appointment | activityid_activitypointer | |
activity_pointer_socialactivity | activityid_activitypointer | |
activity_pointer_task | activityid_activitypointer | |
activitypointer_activity_parties | activityid_activitypointer | |
ActivityPointer_AsyncOperations | regardingobjectid_activitypointer | |
ActivityPointer_BulkDeleteFailures | regardingobjectid_activitypointer | |
ActivityPointer_CampaignActivityItems | campaignactivityid | |
activitypointer_connections1 | record1id_activitypointer | |
activitypointer_connections2 | record2id_activitypointer | |
ActivityPointer_QueueItem | objectid_activitypointer | |
CreatedActivity_BulkOperationLogs | createdobjectid_activitypointer | |
email_actioncard | regardingobjectid_email_actioncard | |
email_activity_mime_attachment | objectid_email | |
email_activity_parties | activityid_email | |
Email_Annotation | objectid_email | |
Email_AsyncOperations | regardingobjectid_email | |
Email_BulkDeleteFailures | regardingobjectid_email | |
email_campaignresponse | originatingactivityid_email | |
email_connections1 | record1id_email | |
email_connections2 | record2id_email | |
Email_DuplicateBaseRecord | baserecordid_email | |
Email_DuplicateMatchingRecord | duplicaterecordid_email | |
email_email_parentactivityid | parentactivityid | |
Email_QueueItem | objectid_email | |
Email_SyncErrors | regardingobjectid_email_syncerror | |
slakpiinstance_activitypointer | regarding_activitypointer | |
slakpiinstance_email | regarding_email |
The following operations are bound to the email entity type.
Name | Bound to |
|---|---|
Collection | |
Entity | |
Entity | |
Entity |
The following operations use the email entity type in a parameter or return type.
Name | How used | Description |
|---|---|---|
entityset Parameter | Creates an email activity record from an incoming email message. | |
ExtraProperties Parameter | Creates an email activity record from an incoming email message. | |
ReturnType | Creates an email activity record from an incoming email message. | |
entity Parameter | Creates an email activity record from the specified email message | |
ExtraProperties Parameter | Creates an email activity record from the specified email message | |
ReturnType | Creates an email activity record from the specified email message | |
entity Parameter | Processes the email responses from a marketing campaign. | |
entity Parameter | Sends an e-mail message. | |
ReturnType | Sends an e-mail message to a recipient using an e-mail template. | |
ExtraProperties Parameter | Check whether the incoming email message is relevant to the Microsoft Dynamics 365 system. |
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright