InstantiateTemplateRequest Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains the parameters that are needed to create an email message from a template (email template).
public ref class InstantiateTemplateRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class InstantiateTemplateRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type InstantiateTemplateRequest = class
inherit OrganizationRequest
Public NotInheritable Class InstantiateTemplateRequest
Inherits OrganizationRequest
- Inheritance
- Attributes
Examples
Example code that demonstrates this message request can be found here: CreateEmailUsingTemplate
Remarks
For the Web API use the InstantiateTemplate action.
Usage
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.
Constructors
InstantiateTemplateRequest() |
Initializes a new instance of the InstantiateTemplateRequest class. |
Properties
ExtensionData |
Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest) |
Item[String] |
Gets or sets the indexer for the |
ObjectId |
Gets or sets the ID of the record that the email is regarding. Required. |
ObjectType |
Gets or sets the type of entity that is represented by the ObjectId property. Required. |
Parameters |
Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest) |
RequestId |
Gets or sets the ID of the request. Optional. (Inherited from OrganizationRequest) |
RequestName |
Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest) |
TemplateId |
Gets or sets the ID of the template. Required. |