Editar

Compartilhar via


Email Template (Template) table/entity reference

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

Messages

The following table lists the messages for the Email Template (Template) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?
Web API Operation SDK for .NET
Assign
Event: True
PATCH /templates(templateid)
Update the ownerid property.
AssignRequest
Create
Event: True
POST /templates
See Create
Create records
Delete
Event: True
DELETE /templates(templateid)
See Delete
Delete records
GrantAccess
Event: True
GrantAccess GrantAccessRequest
InstantiateTemplate
Event: False
InstantiateTemplate InstantiateTemplateRequest
MakeAvailableToOrganizationTemplate
Event: False
MakeAvailableToOrganizationTemplateRequest
MakeAvailableToOrganizationReport
Event: False
MakeAvailableToOrganizationReportRequest
MakeUnavailableToOrganizationTemplate
Event: False
MakeUnavailableToOrganizationTemplateRequest
MakeUnavailableToOrganizationReport
Event: False
MakeUnavailableToOrganizationReportRequest
ModifyAccess
Event: True
ModifyAccess ModifyAccessRequest
Retrieve
Event: True
GET /templates(templateid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /templates
See Query data
Query data
RetrievePrincipalAccess
Event: True
RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True
RevokeAccess RevokeAccessRequest
SendFax
Event: True
SendFax SendFaxRequest
SendEmail
Event: True
SendEmail SendEmailRequest
SendTemplate
Event: True
SendTemplate SendTemplateRequest
Update
Event: True
PATCH /templates(templateid)
See Update
Update records
Upsert
Event: False
PATCH /templates(templateid)
See Upsert a table row
UpsertRequest

Properties

The following table lists selected properties for the Email Template (Template) table.

Property Value
DisplayName Email Template
DisplayCollectionName Email Templates
SchemaName Template
CollectionSchemaName Templates
EntitySetName templates
LogicalName template
LogicalCollectionName templates
PrimaryIdAttribute templateid
PrimaryNameAttribute title
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

Body

Property Value
Description Body text of the email template.
DisplayName Body
IsValidForForm False
IsValidForRead True
LogicalName body
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

Description

Property Value
Description Description of the email template.
DisplayName Description
IsValidForForm False
IsValidForRead True
LogicalName description
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

EntityImage

Property Value
Description Shows the default image for the record.
DisplayName Default Image
IsValidForForm False
IsValidForRead True
LogicalName entityimage
RequiredLevel None
Type Image
CanStoreFullImage False
IsPrimaryImage True
MaxHeight 144
MaxSizeInKB 10240
MaxWidth 144

GenerationTypeCode

Property Value
Description For internal use only.
DisplayName Generation Type Code
IsValidForForm False
IsValidForRead True
LogicalName generationtypecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

IntroducedVersion

Property Value
Description Version in which the form is introduced.
DisplayName Introduced Version
IsValidForForm False
IsValidForRead True
LogicalName introducedversion
RequiredLevel None
Type String
Format VersionNumber
FormatName VersionNumber
ImeMode Auto
IsLocalizable False
MaxLength 48

IsCustomizable

Property Value
Description Information that specifies whether this component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsPersonal

Property Value
Description Information about whether the template is personal or is available to all users.
DisplayName Viewable By
IsValidForForm False
IsValidForRead True
LogicalName ispersonal
RequiredLevel None
Type Boolean
GlobalChoiceName template_ispersonal
DefaultValue True
True Label Individual
False Label Organization

LanguageCode

Property Value
Description Language of the email template.
DisplayName Language
IsValidForForm True
IsValidForRead True
LogicalName languagecode
RequiredLevel ApplicationRequired
Type Integer
MaxValue 2147483647
MinValue 0

MimeType

Property Value
Description MIME type of the email template.
DisplayName Mime Type
IsValidForForm False
IsValidForRead True
LogicalName mimetype
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 256

OwnerId

Property Value
Description Unique identifier of the user or team who owns the template for the email activity.
DisplayName Owner
IsValidForForm False
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Type Owner
Targets systemuser, team

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

PresentationXml

Property Value
Description XML data for the body of the email template.
DisplayName Presentation XML
IsValidForForm False
IsValidForRead True
LogicalName presentationxml
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

SafeHtml

Property Value
Description Safe html of email template.
DisplayName Safe HTML of email template
IsValidForForm True
IsValidForRead True
LogicalName safehtml
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

Subject

Property Value
Description Subject associated with the email template.
DisplayName Subject
IsValidForForm False
IsValidForRead True
LogicalName subject
RequiredLevel ApplicationRequired
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 5000

SubjectPresentationXml

Property Value
Description XML data for the subject of the email template.
DisplayName Subject XML
IsValidForForm False
IsValidForRead True
LogicalName subjectpresentationxml
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

SubjectSafeHtml

Property Value
Description Safe html of email template subject.
DisplayName Safe HTML of email template subject
IsValidForForm True
IsValidForRead True
LogicalName subjectsafehtml
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

TemplateId

Property Value
Description Unique identifier of the template.
DisplayName Email Template
IsValidForForm False
IsValidForRead True
LogicalName templateid
RequiredLevel SystemRequired
Type Uniqueidentifier

TemplateTypeCode

Property Value
Description Type of email template.
DisplayName Template Type
IsValidForForm False
IsValidForRead True
LogicalName templatetypecode
RequiredLevel SystemRequired
Type EntityName

Title

Property Value
Description Title of the template.
DisplayName Title
IsValidForForm False
IsValidForRead True
LogicalName title
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 200

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue -1
GlobalChoiceName componentstate

ComponentState Choices/Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Property Value
Description Unique identifier of the user who created the email template.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the email template was created.
DisplayName Created On
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the template.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

EntityImage_Timestamp

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimage_timestamp
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

EntityImage_URL

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimage_url
RequiredLevel None
Type String
Format Url
FormatName Url
ImeMode Disabled
IsLocalizable False
MaxLength 200

EntityImageId

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimageid
RequiredLevel None
Type Uniqueidentifier

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

IsRecommended

Property Value
Description Indicates if a template is recommended by Dynamics 365.
DisplayName Recommended
IsValidForForm True
IsValidForRead True
LogicalName isrecommended
RequiredLevel None
Type Boolean
GlobalChoiceName template_isrecommended
DefaultValue False
True Label Yes
False Label No

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the template.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the email template was last modified.
DisplayName Modified On
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the template.
DisplayName Modified By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

OpenCount

Property Value
Description For internal use only. Shows the number of times emails that use this template have been opened.
DisplayName Open Count
IsValidForForm False
IsValidForRead True
LogicalName opencount
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

OpenRate

Property Value
Description Shows the open rate of this template. This is based on number of opens on followed emails that use this template.
DisplayName Open Rate
IsValidForForm True
IsValidForRead True
LogicalName openrate
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

OverwriteTime

Property Value
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

OwnerIdName

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwnerIdYomiName

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwningBusinessUnit

Property Value
Description Unique identifier of the business unit that owns the template.
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Type Lookup
Targets businessunit

OwningTeam

Property Value
Description Unique identifier of the team who owns the template.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Type Lookup
Targets team

OwningUser

Property Value
Description Unique identifier of the user who owns the template.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Type Lookup
Targets systemuser

ReplyCount

Property Value
Description For internal use only. Shows the number of times emails that use this template have received replies.
DisplayName Reply Count
IsValidForForm False
IsValidForRead True
LogicalName replycount
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

ReplyRate

Property Value
Description Shows the reply rate for this template. This is based on number of replies received on followed emails that use this template.
DisplayName Reply Rate
IsValidForForm False
IsValidForRead True
LogicalName replyrate
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

TemplateIdUnique

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName templateidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

UsedCount

Property Value
Description Shows the number of sent emails that use this template.
DisplayName Sent email count
IsValidForForm False
IsValidForRead True
LogicalName usedcount
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

VersionNumber

Property Value
Description Version number of the template.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_templates

One-To-Many Relationship: businessunit business_unit_templates

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute owningbusinessunit
ReferencingEntityNavigationPropertyName owningbusinessunit
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_templatebase_createdby

One-To-Many Relationship: systemuser lk_templatebase_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_templatebase_createdonbehalfby

One-To-Many Relationship: systemuser lk_templatebase_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_templatebase_modifiedby

One-To-Many Relationship: systemuser lk_templatebase_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_templatebase_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_templatebase_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

owner_templates

One-To-Many Relationship: owner owner_templates

Property Value
ReferencedEntity owner
ReferencedAttribute ownerid
ReferencingAttribute ownerid
ReferencingEntityNavigationPropertyName ownerid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

system_user_email_templates

One-To-Many Relationship: systemuser system_user_email_templates

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute owninguser
ReferencingEntityNavigationPropertyName owninguser
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

team_email_templates

One-To-Many Relationship: team team_email_templates

Property Value
ReferencedEntity team
ReferencedAttribute teamid
ReferencingAttribute owningteam
ReferencingEntityNavigationPropertyName owningteam
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

Email_EmailTemplate

Many-To-One Relationship: email Email_EmailTemplate

Property Value
ReferencingEntity email
ReferencingAttribute templateid
ReferencedEntityNavigationPropertyName Email_EmailTemplate
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

template_activity_mime_attachments

Many-To-One Relationship: activitymimeattachment template_activity_mime_attachments

Property Value
ReferencingEntity activitymimeattachment
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName template_activity_mime_attachments
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Template_AsyncOperations

Many-To-One Relationship: asyncoperation Template_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Template_AsyncOperations
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Template_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure Template_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Template_BulkDeleteFailures
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Template_Organization

Many-To-One Relationship: organization Template_Organization

Property Value
ReferencingEntity organization
ReferencingAttribute acknowledgementtemplateid
ReferencedEntityNavigationPropertyName Template_Organization
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Template_ProcessSessions

Many-To-One Relationship: processsession Template_ProcessSessions

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Template_ProcessSessions
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 110
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Template_SyncErrors

Many-To-One Relationship: syncerror Template_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Template_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
template