mailmergetemplate EntityType
Template for a mail merge document that contains the standard attributes of that document.
- Entity set path:
- [organization URI]/api/data/v9.2/mailmergetemplates
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Mail Merge Template
- Primary key:
- mailmergetemplateid
- Primary name column:
- 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
|
||||||||||||||
| 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
|
||||||||||||||
| 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
|
||||||||||||||
| ispersonal | Edm.Boolean |
Information about whether the mail merge template is personal or is available to all users. Display name: Viewable By
Default options
|
||||||||||||||
| 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
|
||||||||||||||
| 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
|
||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the mail merge template. Display name: Status Reason
Default options
|
||||||||||||||
| 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 Lookup property data.
| 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. |
| _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 |