InstantiateTemplateRequest InstantiateTemplateRequest InstantiateTemplateRequest InstantiateTemplateRequest Class


Contains the parameters that are needed to create an email message from a template (email template).

For the Web API use the InstantiateTemplate Action.

public ref class InstantiateTemplateRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
public sealed class InstantiateTemplateRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type InstantiateTemplateRequest = class
    inherit OrganizationRequest
Public NotInheritable Class InstantiateTemplateRequest
Inherits OrganizationRequest


      // Use the InstantiateTemplate message to create an e-mail message using a template.
var instTemplateReq = new InstantiateTemplateRequest
    TemplateId = _templateId,
    ObjectId = _accountId,
    ObjectType = Account.EntityLogicalName
var instTemplateResp = (InstantiateTemplateResponse)svc.Execute(instTemplateReq);

// Serialize the email message to XML, and save to a file.
XmlSerializer serializer = new XmlSerializer(typeof(InstantiateTemplateResponse));
string filename = "email-message.xml";

using (StreamWriter writer = new StreamWriter(filename))
    serializer.Serialize(writer, instTemplateResp);
Console.WriteLine("Created e-mail using the template.");

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

Templates#CreateEmailUsingTemplate1 TemplatesVB#CreateEmailUsingTemplate1


Message Availability

This message works regardless whether the caller is connected to the server or offline.


Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of InstantiateTemplateResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Email and Template entities and access rights on the specified record in the TemplateId and ObjectId properties. For a complete list of the required privileges, see InstantiateTemplate message privileges.


InstantiateTemplateRequest() InstantiateTemplateRequest() InstantiateTemplateRequest() InstantiateTemplateRequest()

Initializes a new instance of the InstantiateTemplateRequest class.


ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
ObjectId ObjectId ObjectId ObjectId

Gets or sets the ID of the record that the email is regarding. Required.

ObjectType ObjectType ObjectType ObjectType

Gets or sets the type of entity that is represented by the ObjectId property. Required.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
TemplateId TemplateId TemplateId TemplateId

Gets or sets the ID of the template. Required.

Applies to