Template (email template) entity messages and methods

 

Updated: November 29, 2016

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

The template entity represents a template for an email activity. It provides boilerplate text and Microsoft Dynamics 365 data for email messages. You can attach an email attachment (ActivityMimeAttachment) to a template. Templates cannot be used with Microsoft Office Word mail merges. The schema name for this entity is Template. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message

Description

AssignRequest

Assigns a template to another user or team.

AssociateRequest

Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see the Template entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

CreateRequest

Creates a template. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a template. You can also call the IOrganizationService.Delete method.

DisassociateRequest

Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see Template entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

GrantAccessRequest

Shares a template with another security principal (user or team).

InitializeFromRequest

Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.

InstantiateTemplateRequest

Creates an email from a template.

MakeAvailableToOrganizationTemplateRequest

Deprecated. Use the AssociateRequest class. Makes the specified email template available to the organization.

MakeUnavailableToOrganizationTemplateRequest

Deprecated. Use the DisassociateRequest class. Makes the specified email template unavailable to the organization.

ModifyAccessRequest

Changes the access rights for a template previously shared with another security principal (user or team).

RetrieveDuplicatesRequest

Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.

RetrieveRequest

Retrieves a template. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of templates. You can also call the IOrganizationService.RetrieveMultiple method.

RetrievePrincipalAccessRequest

Retrieves the access rights that the specified security principal (user or team) has to a template.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves the security principals (users or teams) that have access to a template, and also retrieves their access rights to the template.

RevokeAccessRequest

Removes all access rights to a template for the specified security principal (user or team).

SendTemplateRequest

Sends a bulk email message that is created from a template.

UpdateRequest

Updates a template. You can also call the IOrganizationService.Update method.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Show: