Mail Merge Template (MailMergeTemplate) table/entity reference

Template for a mail merge document that contains the standard attributes of that document.

Messages

The following table lists the messages for the Mail Merge Template (MailMergeTemplate) 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: False	PATCH /mailmergetemplates(mailmergetemplateid) Update the ownerid property.	AssignRequest
Create Event: False	POST /mailmergetemplates See Create	Create records
Delete Event: False	DELETE /mailmergetemplates(mailmergetemplateid) See Delete	Delete records
GrantAccess Event: False	GrantAccess	GrantAccessRequest
ModifyAccess Event: False	ModifyAccess	ModifyAccessRequest
Retrieve Event: False	GET /mailmergetemplates(mailmergetemplateid) See Retrieve	Retrieve records
RetrieveMultiple Event: False	GET /mailmergetemplates See Query data	Query data
RetrievePrincipalAccess Event: False	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess Event: False	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess Event: False	RevokeAccess	RevokeAccessRequest
SetState Event: False	PATCH /mailmergetemplates(mailmergetemplateid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: False	PATCH /mailmergetemplates(mailmergetemplateid) See Update	Update records
Upsert Event: False	PATCH /mailmergetemplates(mailmergetemplateid) See Upsert a table row	UpsertRequest

Properties

The following table lists selected properties for the Mail Merge Template (MailMergeTemplate) table.

Property	Value
DisplayName	Mail Merge Template
DisplayCollectionName	Mail Merge Templates
SchemaName	MailMergeTemplate
CollectionSchemaName	MailMergeTemplates
EntitySetName	mailmergetemplates
LogicalName	mailmergetemplate
LogicalCollectionName	mailmergetemplates
PrimaryIdAttribute	mailmergetemplateid
PrimaryNameAttribute	name
TableType	Standard
OwnershipType	UserOwned

Writable columns/attributes

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

• Body
• DefaultFilter
• Description
• DocumentFormat
• FileName
• IntroducedVersion
• IsCustomizable
• IsPersonal
• LanguageCode
• MailMergeTemplateId
• MailMergeType
• MimeType
• Name
• OwnerId
• OwnerIdType
• StateCode
• StatusCode
• TemplateTypeCode
• TimeZoneRuleVersionNumber
• TransactionCurrencyId
• UTCConversionTimeZoneCode

Body

Property	Value
Description	Body text of the mail merge template.
DisplayName	Body
IsValidForForm	True
IsValidForRead	True
LogicalName	body
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

DefaultFilter

Property	Value
Description	Default data fields associated with the mail merge template.
DisplayName	Default filter
IsValidForForm	True
IsValidForRead	True
LogicalName	defaultfilter
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

Description

Property	Value
Description	Description of the mail merge template.
DisplayName	Description
IsValidForForm	True
IsValidForRead	True
LogicalName	description
RequiredLevel	None
Type	String
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	256

DocumentFormat

Property	Value
Description	Version of the Microsoft Office Word XML format used by the template.
DisplayName	Document Format
IsValidForForm	True
IsValidForRead	True
LogicalName	documentformat
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	mailmergetemplate_documentformat

DocumentFormat Choices/Options

Value	Label
1	2003
2	2007

FileName

Property	Value
Description	File name of the mail merge template.
DisplayName	File Name
IsValidForForm	True
IsValidForRead	True
LogicalName	filename
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	255

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 mail merge template is personal or is available to all users.
DisplayName	Viewable By
IsValidForForm	False
IsValidForRead	True
LogicalName	ispersonal
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	mailmergetemplate_ispersonal
DefaultValue	True
True Label	Individual
False Label	Organization

LanguageCode

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

MailMergeTemplateId

Property	Value
Description	Unique identifier of the mail merge template.
DisplayName	Mail Merge Template
IsValidForForm	False
IsValidForRead	True
LogicalName	mailmergetemplateid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

MailMergeType

Property	Value
Description	Drop-down list for selecting the type of the mail merge.
DisplayName	Mail Merge Type
IsValidForForm	True
IsValidForRead	True
LogicalName	mailmergetype
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	mailmergetemplate_mailmergetype

MailMergeType Choices/Options

Value	Label
1	Letter
2	Email Message
3	Envelope
4	Labels
5	Quotes
6	Fax

MimeType

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

Name

Property	Value
Description	Name of the mail merge template.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	name
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	425

OwnerId

Property	Value
Description	Unique identifier of the user or team who owns the mail merge template.
DisplayName	Owner
IsValidForForm	True
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

StateCode

Property	Value
Description	Status of the mail merge template.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue	0
GlobalChoiceName	mailmergetemplate_statecode

StateCode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 1 InvariantName: Active
1	Label: Inactive DefaultStatus: 2 InvariantName: Inactive

StatusCode

Property	Value
Description	Reason for the status of the mail merge template.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue	-1
GlobalChoiceName	mailmergetemplate_statuscode

StatusCode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

TemplateTypeCode

Property	Value
Description	Type of mail merge template.
DisplayName	Associated Entity
IsValidForForm	True
IsValidForRead	True
LogicalName	templatetypecode
RequiredLevel	SystemRequired
Type	EntityName

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

TransactionCurrencyId

Property	Value
Description	Unique identifier of the currency associated with the mailmergetemplate.
DisplayName	Currency
IsValidForForm	True
IsValidForRead	True
LogicalName	transactioncurrencyid
RequiredLevel	None
Type	Lookup
Targets	transactioncurrency

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

Read-only columns/attributes

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

• ComponentState
• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• ExchangeRate
• FileSize
• IsManaged
• MailMergeTemplateIdUnique
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OverwriteTime
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• ParameterXml
• SolutionId
• SupportingSolutionId
• VersionNumber

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 mail merge template.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Date and time when the mail merge template was created.
DisplayName	Created On
IsValidForForm	True
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 mailmergetemplate.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

ExchangeRate

Property	Value
Description	Exchange rate for the currency associated with the mailmergetemplate with respect to the base currency.
DisplayName	Exchange Rate
IsValidForForm	True
IsValidForRead	True
LogicalName	exchangerate
RequiredLevel	None
Type	Decimal
ImeMode	Disabled
MaxValue	100000000000
MinValue	1E-12
Precision	12
SourceTypeMask	0

FileSize

Property	Value
Description	File size of the mail merge template.
DisplayName	File Size (Bytes)
IsValidForForm	False
IsValidForRead	True
LogicalName	filesize
RequiredLevel	None
Type	Integer
MaxValue	1000000000
MinValue	0

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

MailMergeTemplateIdUnique

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

ModifiedBy

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

ModifiedOn

Property	Value
Description	Date and time when the mail merge template was last modified.
DisplayName	Modified On
IsValidForForm	True
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 mailmergetemplate.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

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 mail merge 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 mail merge 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 mail merge template.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Type	Lookup
Targets	systemuser

ParameterXml

Property	Value
Description	Parameter Xml.
DisplayName	Parameter Xml
IsValidForForm	True
IsValidForRead	True
LogicalName	parameterxml
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1073741823

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

VersionNumber

Property	Value
Description	Version number of the mail merge 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_mailmergetemplates
• lk_mailmergetemplate_createdonbehalfby
• lk_mailmergetemplate_modifiedonbehalfby
• lk_mailmergetemplatebase_createdby
• lk_mailmergetemplatebase_modifiedby
• owner_mailmergetemplates
• TransactionCurrency_MailMergeTemplate

business_unit_mailmergetemplates

One-To-Many Relationship: businessunit business_unit_mailmergetemplates

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_mailmergetemplate_createdonbehalfby

One-To-Many Relationship: systemuser lk_mailmergetemplate_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_mailmergetemplate_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_mailmergetemplate_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

lk_mailmergetemplatebase_createdby

One-To-Many Relationship: systemuser lk_mailmergetemplatebase_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_mailmergetemplatebase_modifiedby

One-To-Many Relationship: systemuser lk_mailmergetemplatebase_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

owner_mailmergetemplates

One-To-Many Relationship: owner owner_mailmergetemplates

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

TransactionCurrency_MailMergeTemplate

One-To-Many Relationship: transactioncurrency TransactionCurrency_MailMergeTemplate

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

One-to-Many relationships

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

• MailMergeTemplate_AsyncOperations
• mailmergetemplate_principalobjectattributeaccess
• MailMergeTemplate_ProcessSessions
• MailMergeTemplate_SyncErrors

MailMergeTemplate_AsyncOperations

Many-To-One Relationship: asyncoperation MailMergeTemplate_AsyncOperations

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

mailmergetemplate_principalobjectattributeaccess

Many-To-One Relationship: principalobjectattributeaccess mailmergetemplate_principalobjectattributeaccess

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

MailMergeTemplate_ProcessSessions

Many-To-One Relationship: processsession MailMergeTemplate_ProcessSessions

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

MailMergeTemplate_SyncErrors

Many-To-One Relationship: syncerror MailMergeTemplate_SyncErrors

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	MailMergeTemplate_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
mailmergetemplate