DistributeCampaignActivityRequest 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 create a bulk operation that distributes a campaign activity. The appropriate activities, such as a phone call or fax, are created for the members of the list that is associated with the specified campaign activity.

For the Web API use the DistributeCampaignActivity 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.DistributeCampaignActivityRequest

Syntax

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

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

Constructors

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

Properties

	Name	Description
	Activity	Gets or sets the activity to be distributed. Required.
	CampaignActivityId	Gets or sets the ID of the campaign activity for which the activity is distributed. Required.
	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.)
	Owner	Gets or sets the owner for the newly created activity. Required.
	OwnershipOptions	Gets or sets the ownership options for the activity. Required.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	PostWorkflowEvent	Gets or sets a value that indicates whether an asynchronous job is used to distribute activities, such as an email, fax, or letter, to the members of a list. Required.
	Propagate	Gets or sets a value that indicates whether the activity is both created and executed. Required.
	QueueId	Gets or sets the ID of the queue to which the created activity is added. Optional.
	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.)
	SendEmail	Gets or sets a value that indicates whether to send an email about the new activity. Required.
	TemplateId	Gets or sets the ID of the email template. Required.

Methods

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

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the CampaignActivity, Queue, and Template entities and on the specified entity in the Activity property. You must also have access rights on the specified records in the following properties: CampaignActivityId, QueueId, and TemplateId. For a complete list of the required privileges, see DistributeCampaignActivity message privileges.

Notes for Callers

This operation distributes activities that specify a recipient: phone call, appointment, letter, letter via mail merge, fax, fax via mail merge, email, and email via mail merge.

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.

Partager via