AddItemCampaignActivityRequest 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 add an item to a campaign activity.

For the Web API use the AddItemCampaignActivity 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.AddItemCampaignActivityRequest

Syntax

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

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

Constructors

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

Properties

	Name	Description
	CampaignActivityId	Gets or sets the ID of the campaign activity. Required.
	EntityName	Gets or sets the name of the entity type that is used in the operation. 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.)
	ItemId	Gets or sets the ID of the item to be added to the campaign activity. 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 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.)

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 AddItemCampaignActivityResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the CampaignActivity entity and on the specified entity in the ItemId property. The caller must also have access rights on the specified records in the CampaignActivityId and ItemId properties.

For a complete list of the required privileges, see AddItemCampaignActivity message privileges.

Notes to Callers

The added item must be one of the following entity types: List or SalesLiterature.

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.