template EntityType
Template for an email message that contains the standard attributes of an email message.
- Entity set path:
- [organization URI]/api/data/v9.2/templates
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Email Template
- Primary key:
- templateid
- Primary name column:
- 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
|
||||||||||
| 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 |
||||||||||
| entityimage | Edm.Binary |
Shows the default image for the record. Display name: Default Image |
||||||||||
| entityimage_timestamp | Edm.Int64 |
Read only
|
||||||||||
| entityimage_url | Edm.String |
Read only
|
||||||||||
| entityimageid | Edm.Guid |
Read only
|
||||||||||
| 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
|
||||||||||
| ispersonal | Edm.Boolean |
Information about whether the template is personal or is available to all users. Display name: Viewable By
Default options
|
||||||||||
| isrecommended | Edm.Boolean |
Indicates if a template is recommended by Dynamics 365. Display name: Recommended Read only
Default options
|
||||||||||
| 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
|
||||||||||
| safehtml | Edm.String |
Safe html of email template. Display name: Safe HTML of email template |
||||||||||
| 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 |
||||||||||
| subjectsafehtml | Edm.String |
Safe html of email template subject. Display name: Safe HTML of email template subject |
||||||||||
| 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 Lookup property data.
| 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 | 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 |