AddItemCampaignRequest Class


Applies To: Dynamics CRM 2015

Contains the data that is needed to add an item to a campaign.

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

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class AddItemCampaignRequest : OrganizationRequest
[DataContractAttribute(Namespace = "")]
public ref class AddItemCampaignRequest sealed : OrganizationRequest
[<DataContractAttribute(Namespace = "")>]
type AddItemCampaignRequest = 
        inherit OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class AddItemCampaignRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod AddItemCampaignRequest()

Initializes a new instance of the AddItemCampaignRequest class.


Name Description
System_CAPS_pubproperty CampaignId

Gets or sets the ID of the campaign. Required.

System_CAPS_pubproperty EntityId

Gets or sets the ID of the record to be added to the campaign. Required.

System_CAPS_pubproperty EntityName

Gets or sets the name of the type of entity that is used in the operation. Required.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Message Availability

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


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

Privileges and Access Rights

To perform this action, the caller must have privileges on the Campaign entity and on the entity that is specified in the EntityId property. The caller must also have access rights on the specified records in the CampaignId and EntityId properties.

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

Notes to Callers

The added item must be one of the following entity types: Campaign, List, Product, 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.

See Also

Microsoft.Crm.Sdk.Messages Namespace
Campaign entities
Sample: Distribute campaign activities to dynamic and static lists
Sample: Distribute campaign activities to qualified marketing list
AddItemCampaign message privileges
CampaignItem intersect entity metadata
How role-based security can be used to control access to entities in Microsoft Dynamics CRM
How record-based security can be used to control access to records in Microsoft Dynamics CRM

Return to top

© 2016 Microsoft. All rights reserved. Copyright