AddItemCampaignActivityRequest Class

 

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 = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class AddItemCampaignActivityRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class AddItemCampaignActivityRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod AddItemCampaignActivityRequest()

Initializes a new instance of the AddItemCampaignActivityRequest class.

Properties

Name Description
System_CAPS_pubproperty CampaignActivityId

Gets or sets the ID of the campaign activity. Required.

System_CAPS_pubproperty EntityName

Gets or sets the name of the entity type 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 ItemId

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

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

Methods

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

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.

See Also

AddItemCampaignActivityResponse
Microsoft.Crm.Sdk.Messages Namespace
Campaign entities
Sample: Distribute campaign activities to dynamic and static lists
AddItemCampaignActivity message privileges
CampaignActivityItem intersect entity metadata
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright