SendTemplateRequest Class

Definition

Namespace:

Microsoft.Crm.Sdk.Messages

Assembly:

Microsoft.Crm.Sdk.Proxy.dll

Package:

Microsoft.PowerPlatform.Dataverse.Client v1.1.17

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

public ref class SendTemplateRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SendTemplateRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type SendTemplateRequest = class
    inherit OrganizationRequest

Public NotInheritable Class SendTemplateRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

SendTemplateRequest

Attributes

DataContractAttribute

Remarks

For the Web API use the SendTemplate action.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the Email Template (Template) entity and access rights on the specified record in the TemplateId property.

Constructors

SendTemplateRequest()

Initializes a new instance of the SendTemplateRequest class.

Properties

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 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)
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.

See also

• SendTemplateResponse