template EntityType
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Description: Template for an email message that contains the standard attributes of an email message.
Entity Set path:[organization URI]/api/data/v8.2/templates
Base Type: crmbaseentity EntityType
Display Name: Email Template
Primary Key: templateid
Primary Name Attribute: title
Single-valued navigation properties
Properties represent fields of data stored in the entity. Some properties are read-only.
Name | Type | Details |
|---|---|---|
body | Edm.String | Description: Body text of the email template. Display Name: Body |
componentstate | Edm.Int32 | Description: For internal use only. Default Options: 0 : Published Display Name: Component State Read-only property |
createdon | Edm.DateTimeOffset | Description: Date and time when the email template was created. Display Name: Created On Read-only property |
description | Edm.String | Description: Description of the email template. Display Name: Description |
generationtypecode | Edm.Int32 | Description: For internal use only. Display Name: Generation Type Code |
importsequencenumber | Edm.Int32 | Description: Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
introducedversion | Edm.String | Description: Version in which the form is introduced. Display Name: Introduced Version |
iscustomizable | Description: Information that specifies whether this component can be customized. Display Name: Customizable | |
ismanaged | Edm.Boolean | Description: Indicates whether the solution component is part of a managed solution. Default Options: 1 : Managed Display Name: Is Managed Read-only property |
ispersonal | Edm.Boolean | Description: Information about whether the template is personal or is available to all users. Default Options: 1 : Individual Display Name: Viewable By |
isrecommended | Edm.Boolean | Description: Indicates if a template is recommended by Dynamics 365. Default Options: 1 : Yes Display Name: Recommended Read-only property |
languagecode | Edm.Int32 | Description: Language of the email template. Display Name: Language |
mimetype | Edm.String | Description: MIME type of the email template. Display Name: Mime Type |
modifiedon | Edm.DateTimeOffset | Description: Date and time when the email template was last modified. Display Name: Modified On Read-only property |
opencount | Edm.Int32 | Description: For internal use only. Shows the number of times emails that use this template have been opened. Display Name: Open Count Read-only property |
openrate | Edm.Int32 | Description: Shows the open rate of this template. This is based on number of opens on followed emails that use this template. Display Name: Open Rate Read-only property |
overwritetime | Edm.DateTimeOffset | Description: For internal use only. Display Name: Record Overwrite Time Read-only property |
presentationxml | Edm.String | Description: XML data for the body of the email template. Display Name: Presentation XML |
replycount | Edm.Int32 | Description: For internal use only. Shows the number of times emails that use this template have received replies. Display Name: Reply Count Read-only property |
replyrate | Edm.Int32 | Description: Shows the reply rate for this template. This is based on number of replies received on followed emails that use this template. Display Name: Reply Rate Read-only property |
solutionid | Edm.Guid | Description: Unique identifier of the associated solution. Display Name: Solution Read-only property |
subject | Edm.String | Description: Subject associated with the email template. Display Name: Subject |
subjectpresentationxml | Edm.String | Description: XML data for the subject of the email template. Display Name: Subject XML |
templateid | Edm.Guid | Description: Unique identifier of the template. Display Name: Email Template |
templateidunique | Edm.Guid | Description: For internal use only. Read-only property |
templatetypecode | Edm.String | Description: Type of email template. Display Name: Template Type |
title | Edm.String | Description: Title of the template. Display Name: Title |
usedcount | Edm.Int32 | Description: Shows the number of sent emails that use this template. Display Name: Sent email count Read-only property |
versionnumber | Edm.Int64 | Description: Version number of the template. Display Name: Version Number Read-only property |
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 | createdby | Unique identifier of the user who created the email template. |
_createdonbehalfby_value | createdonbehalfby | Unique identifier of the delegate user who created the template. |
_modifiedby_value | modifiedby | Unique identifier of the user who last modified the template. |
_modifiedonbehalfby_value | modifiedonbehalfby | Unique identifier of the delegate user who last modified the template. |
_ownerid_value | ownerid | Unique identifier of the user or team who owns the template for the email activity. |
_owningbusinessunit_value | owningbusinessunit | Unique identifier of the business unit that owns the template. |
_owningteam_value | owningteam | Unique identifier of the team who owns the template. |
_owninguser_value | owninguser | Unique identifier of the user who owns the template. |
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 |
|---|---|---|
createdby | lk_templatebase_createdby | |
createdonbehalfby | lk_templatebase_createdonbehalfby | |
modifiedby | lk_templatebase_modifiedby | |
modifiedonbehalfby | lk_templatebase_modifiedonbehalfby | |
ownerid | owner_templates | |
owningbusinessunit | business_unit_templates | |
owningteam | team_email_templates | |
owninguser | system_user_email_templates |
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 |
|---|---|---|
Email_EmailTemplate | templateid | |
template_activity_mime_attachments | objectid_template | |
Template_AsyncOperations | regardingobjectid_template | |
Template_BulkDeleteFailures | regardingobjectid_template | |
Template_Organization | acknowledgementtemplateid | |
Template_SyncErrors | regardingobjectid_template_syncerror |
The following operations use the template entity type in a parameter or return type.
Name | How used | Description |
|---|---|---|
Template Parameter | Creates a bulk operation that distributes a campaign activity. |
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright