mailmergetemplate EntityType

Entity Set Path
[organization URI]/api/data/v9.0/mailmergetemplates
Base Type
crmbaseentity
Display Name
Mail Merge Template
Primary Key
mailmergetemplateid
Primary Key Attribute
name
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 mail merge 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 mail merge template was created.

Display Name: Created On

Read Only
defaultfilter Edm.String

Default data fields associated with the mail merge template.

Display Name: Default filter

description Edm.String

Description of the mail merge template.

Display Name: Description

documentformat Edm.Int32

Version of the Microsoft Office Word XML format used by the template.

Display Name: Document Format

Default Options
Value Label
1 2003
2 2007
exchangerate Edm.Decimal

Exchange rate for the currency associated with the mailmergetemplate with respect to the base currency.

Display Name: Exchange Rate

Read Only
filename Edm.String

File name of the mail merge template.

Display Name: File Name

filesize Edm.Int32

File size of the mail merge template.

Display Name: File Size (Bytes)

Read Only
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 mail merge template is personal or is available to all users.

Display Name: Viewable By

Default Options
Value Label
1 Individual
0 Organization
languagecode Edm.Int32

Language of the mail merge template.

Display Name: Language

mailmergetemplateid Edm.Guid

Unique identifier of the mail merge template.

Display Name: Mail Merge Template

mailmergetemplateidunique Edm.Guid

For internal use only.

Read Only
mailmergetype Edm.Int32

Drop-down list for selecting the type of the mail merge.

Display Name: Mail Merge Type

Default Options
Value Label
1 Letter
2 Email Message
3 Envelope
4 Labels
5 Quotes
6 Fax
mimetype Edm.String

MIME type of the mail merge template.

Display Name: Mime Type

modifiedon Edm.DateTimeOffset

Date and time when the mail merge template was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of the mail merge template.

Display Name: Name

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
parameterxml Edm.String

Parameter Xml.

Display Name: Parameter Xml

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the mail merge template.

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the mail merge template.

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
templatetypecode Edm.String

Type of mail merge template.

Display Name: Associated Entity

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version number of the mail merge 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 mail merge template.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the mailmergetemplate.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the mail merge template.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the mailmergetemplate.

_ownerid_value ownerid

Unique identifier of the user or team who owns the mail merge template.

_owningbusinessunit_value owningbusinessunit

Unique identifier of the business unit that owns the mail merge template.

_owningteam_value createdby

Unique identifier of the team who owns the mail merge template.

_owninguser_value createdby

Unique identifier of the user who owns the mail merge template.

_transactioncurrencyid_value transactioncurrencyid

Unique identifier of the currency associated with the mailmergetemplate.

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_mailmergetemplatebase_createdby
createdonbehalfby systemuser lk_mailmergetemplate_createdonbehalfby
modifiedby systemuser lk_mailmergetemplatebase_modifiedby
modifiedonbehalfby systemuser lk_mailmergetemplate_modifiedonbehalfby
ownerid principal owner_mailmergetemplates
owningbusinessunit businessunit business_unit_mailmergetemplates
transactioncurrencyid transactioncurrency TransactionCurrency_MailMergeTemplate

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
MailMergeTemplate_AsyncOperations asyncoperation regardingobjectid_mailmergetemplate
mailmergetemplate_principalobjectattributeaccess principalobjectattributeaccess objectid_mailmergetemplate
MailMergeTemplate_ProcessSessions processsession regardingobjectid_mailmergetemplate
MailMergeTemplate_SyncErrors syncerror regardingobjectid_mailmergetemplate_syncerror

Operations

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

Name Binding
GrantAccess Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the mailmergetemplate entity type.

Name Description
Sales Dynamics 365 workload for sales.
System Solution Internal CRM System Solution

See Also