MailMergeTemplate Entity Reference

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

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/mailmergetemplates(mailmergetemplateid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/mailmergetemplates
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/mailmergetemplates(mailmergetemplateid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/mailmergetemplates(mailmergetemplateid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/mailmergetemplates
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/mailmergetemplates(mailmergetemplateid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/mailmergetemplates(mailmergetemplateid)
See Update
UpdateRequest or
Update

Entity Properties

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

Writable attributes

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

Body

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

DefaultFilter

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

Description

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

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

DocumentFormat Options

Value Label
1 2003
2 2007

FileName

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

IntroducedVersion

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

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

IsPersonal Options

Value Label
1 Individual
0 Organization

DefaultValue: True

LanguageCode

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

MailMergeTemplateId

Property Value
Description Unique identifier of the mail merge template.
DisplayName Mail Merge Template
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
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

MailMergeType 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
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName mimetype
MaxLength 256
RequiredLevel None
Type String

Name

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

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
Targets systemuser,team
Type Owner

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
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 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

StatusCode Options

Value Label State
1 Active 0
2 Inactive 1

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
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TransactionCurrencyId

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

UTCConversionTimeZoneCode

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

Read-only attributes

These attributes return false for both IsValidForCreate or 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

ComponentState 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
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the mail merge template was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

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
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

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
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

FileSize

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

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

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

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
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the mail merge template was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

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
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OverwriteTime

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

OwnerIdName

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

OwnerIdYomiName

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

OwningBusinessUnit

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

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
Targets team
Type Lookup

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
Targets systemuser
Type Lookup

ParameterXml

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

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

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

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

One-To-Many Relationships

Listed by SchemaName.

MailMergeTemplate_SyncErrors

Same as syncerror entity MailMergeTemplate_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName MailMergeTemplate_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

MailMergeTemplate_AsyncOperations

Same as asyncoperation entity MailMergeTemplate_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName MailMergeTemplate_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

mailmergetemplate_principalobjectattributeaccess

Same as principalobjectattributeaccess entity mailmergetemplate_principalobjectattributeaccess Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName mailmergetemplate_principalobjectattributeaccess
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

MailMergeTemplate_ProcessSessions

Same as processsession entity MailMergeTemplate_ProcessSessions Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName MailMergeTemplate_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_mailmergetemplatebase_createdby

See systemuser Entity lk_mailmergetemplatebase_createdby One-To-Many relationship.

business_unit_mailmergetemplates

See businessunit Entity business_unit_mailmergetemplates One-To-Many relationship.

TransactionCurrency_MailMergeTemplate

See transactioncurrency Entity TransactionCurrency_MailMergeTemplate One-To-Many relationship.

lk_mailmergetemplatebase_modifiedby

See systemuser Entity lk_mailmergetemplatebase_modifiedby One-To-Many relationship.

lk_mailmergetemplate_modifiedonbehalfby

See systemuser Entity lk_mailmergetemplate_modifiedonbehalfby One-To-Many relationship.

lk_mailmergetemplate_createdonbehalfby

See systemuser Entity lk_mailmergetemplate_createdonbehalfby One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
mailmergetemplate EntityType