template EntityType

Template for an email message that contains the standard attributes of an email message.

Entity Set Path
[organization URI]/api/data/v9.0/templates
Base Type
crmbaseentity
Display Name
Email Template
Primary Key
templateid
Primary Key Attribute
title
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
body Edm.String

Body text of the email template.

Display Name: Body

componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Date and time when the email template was created.

Display Name: Created On

Read Only
description Edm.String

Description of the email template.

Display Name: Description

generationtypecode Edm.Int32

For internal use only.

Display Name: Generation Type Code

importsequencenumber Edm.Int32

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

Display Name: Import Sequence Number

introducedversion Edm.String

Version in which the form is introduced.

Display Name: Introduced Version

iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display Name: Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
ispersonal Edm.Boolean

Information about whether the template is personal or is available to all users.

Display Name: Viewable By

Default Options
Value Label
1 Individual
0 Organization
isrecommended Edm.Boolean

Indicates if a template is recommended by Dynamics 365.

Display Name: Recommended

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

Language of the email template.

Display Name: Language

mimetype Edm.String

MIME type of the email template.

Display Name: Mime Type

modifiedon Edm.DateTimeOffset

Date and time when the email template was last modified.

Display Name: Modified On

Read Only
opencount Edm.Int32

For internal use only. Shows the number of times emails that use this template have been opened.

Display Name: Open Count

Read Only
openrate Edm.Int32

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
overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
presentationxml Edm.String

XML data for the body of the email template.

Display Name: Presentation XML

replycount Edm.Int32

For internal use only. Shows the number of times emails that use this template have received replies.

Display Name: Reply Count

Read Only
replyrate Edm.Int32

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
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
subject Edm.String

Subject associated with the email template.

Display Name: Subject

subjectpresentationxml Edm.String

XML data for the subject of the email template.

Display Name: Subject XML

templateid Edm.Guid

Unique identifier of the template.

Display Name: Email Template

templateidunique Edm.Guid

For internal use only.

Read Only
templatetypecode Edm.String

Type of email template.

Display Name: Template Type

title Edm.String

Title of the template.

Display Name: Title

usedcount Edm.Int32

Shows the number of sent emails that use this template.

Display Name: Sent email count

Read Only
versionnumber Edm.Int64

Version number of the template.

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
_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

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 systemuser lk_templatebase_createdby
createdonbehalfby systemuser lk_templatebase_createdonbehalfby
modifiedby systemuser lk_templatebase_modifiedby
modifiedonbehalfby systemuser lk_templatebase_modifiedonbehalfby
ownerid principal owner_templates
owningbusinessunit businessunit business_unit_templates
owningteam team team_email_templates
owninguser systemuser system_user_email_templates

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
Email_EmailTemplate email templateid
template_activity_mime_attachments activitymimeattachment objectid_template
Template_AsyncOperations asyncoperation regardingobjectid_template
Template_BulkDeleteFailures bulkdeletefailure regardingobjectid_template
Template_Organization organization acknowledgementtemplateid
Template_ProcessSessions processsession regardingobjectid_template
Template_SyncErrors syncerror regardingobjectid_template_syncerror

Operations

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

Name Binding
GrantAccess Not Bound
InstantiateTemplate Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
SendEmail Not Bound
SendFax Not Bound
SendTemplate Not Bound

Solutions

The following solutions include the template entity type.

Name Description
App for Outlook
Activities Dynamics 365 workload for activities.
Lead Management Dynamics 365 workload for lead management.
Marketing Dynamics 365 workload for marketing and enterprise.
Sales Dynamics 365 workload for sales.
Service Dynamics 365 workload for service.
System Solution Internal CRM System Solution

See also