SendTemplateRequest Class

Article
11/28/2016

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

Contains the data that is needed to send a bulk email message that is created from a template.

For the Web API use the SendTemplate Action.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.SendTemplateRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SendTemplateRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class SendTemplateRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	SendTemplateRequest()	Initializes a new instance of the SendTemplateRequest class.

Properties

	Name	Description
	DeliveryPriorityCode	Gets or sets the delivery priority code for the email.
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RecipientIds	Gets or sets the array that contains the list of recipients for the email. Required.
	RecipientType	Gets or sets the type of entity that is represented by the list of recipients. Required.
	RegardingId	Gets or sets the ID of a record that the email is regarding. Required.
	RegardingType	Gets or sets the type of entity that is represented by the regarding ID. Required.
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	Sender	Gets or sets the sender of the email.
	TemplateId	Gets or sets the ID of the template to be used for the email. Required.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

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

Usage

Pass an instance of this class to the Execute method, which returns an instance of the SendTemplateResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Template entity and access rights on the specified record in the TemplateId property. For a list of the required privileges, see SendTemplate message privileges.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via