Share via


mailmergetemplate EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

Entity Set path:[organization URI]/api/data/v8.2/mailmergetemplates

Base Type: crmbaseentity EntityType

Display Name: Mail Merge Template

Primary Key: mailmergetemplateid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Properties

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

Name

Type

Details

body

Edm.String

Description: Body text of the mail merge template.

Display Name: Body

componentstate

Edm.Int32

Description: For internal use only.

Default Options:

0 : Published
1 : Unpublished
2 : Deleted
3 : Deleted Unpublished

Display Name: Component State

Read-only property

createdon

Edm.DateTimeOffset

Description: Date and time when the mail merge template was created.

Display Name: Created On

Read-only property

defaultfilter

Edm.String

Description: Default data fields associated with the mail merge template.

Display Name: Default filter

description

Edm.String

Description: Description of the mail merge template.

Display Name: Description

documentformat

Edm.Int32

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

Default Options:

1 : 2003
2 : 2007

Display Name: Document Format

exchangerate

Edm.Decimal

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

Display Name: Exchange Rate

Read-only property

filename

Edm.String

Description: File name of the mail merge template.

Display Name: File Name

filesize

Edm.Int32

Description: File size of the mail merge template.

Display Name: File Size (Bytes)

Read-only property

introducedversion

Edm.String

Description: Version in which the form is introduced.

Display Name: Introduced Version

iscustomizable

BooleanManagedProperty ComplexType

Description: Information that specifies whether this component can be customized.

Display Name: Customizable

ismanaged

Edm.Boolean

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

Default Options:

1 : Managed
0 : Unmanaged

Display Name: Is Managed

Read-only property

ispersonal

Edm.Boolean

Description: Information about whether the mail merge template is personal or is available to all users.

Default Options:

1 : Individual
0 : Organization

Display Name: Viewable By

languagecode

Edm.Int32

Description: Language of the mail merge template.

Display Name: Language

mailmergetemplateid

Edm.Guid

Description: Unique identifier of the mail merge template.

Display Name: Mail Merge Template

mailmergetemplateidunique

Edm.Guid

Description: For internal use only.

Read-only property

mailmergetype

Edm.Int32

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

Default Options:

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

Display Name: Mail Merge Type

mimetype

Edm.String

Description: MIME type of the mail merge template.

Display Name: Mime Type

modifiedon

Edm.DateTimeOffset

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

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of the mail merge template.

Display Name: Name

overwritetime

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Record Overwrite Time

Read-only property

parameterxml

Edm.String

Description: Parameter Xml.

Display Name: Parameter Xml

Read-only property

solutionid

Edm.Guid

Description: Unique identifier of the associated solution.

Display Name: Solution

Read-only property

statecode

Edm.Int32

Description: Status of the mail merge template.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Reason for the status of the mail merge template.

Default Options:

1 : Active
2 : Inactive

Display Name: Status Reason

templatetypecode

Edm.String

Description: Type of mail merge template.

Display Name: Associated Entity

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode

Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

versionnumber

Edm.Int64

Description: Version number of the mail merge template.

Display Name: Version Number

Read-only property

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

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

_owninguser_value

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 EntityType

lk_mailmergetemplatebase_createdby

createdonbehalfby

systemuser EntityType

lk_mailmergetemplate_createdonbehalfby

modifiedby

systemuser EntityType

lk_mailmergetemplatebase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_mailmergetemplate_modifiedonbehalfby

ownerid

principal EntityType

owner_mailmergetemplates

owningbusinessunit

businessunit EntityType

business_unit_mailmergetemplates

transactioncurrencyid

transactioncurrency EntityType

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 EntityType

regardingobjectid_mailmergetemplate

MailMergeTemplate_SyncErrors

syncerror EntityType

regardingobjectid_mailmergetemplate_syncerror

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright