CopyCampaignRequest Class

  • Reference

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 copy a campaign.

public ref class CopyCampaignRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CopyCampaignRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type CopyCampaignRequest = class
    inherit OrganizationRequest
Public NotInheritable Class CopyCampaignRequest
Inherits OrganizationRequest
Inheritance
Object
OrganizationRequest
CopyCampaignRequest
Attributes
DataContractAttribute

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface instance. 

/// <summary>
/// Demonstrates the CopyCampaign message
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance.</param>
/// <param name="originalCampaignId">The ID of the campaign to copy.</param>
/// <returns>The ID of the new Campaign.</returns>
static Guid CopyCampaignExample(IOrganizationService service, 
      Guid originalCampaignId)
{
      // Copy the campaign.
      CopyCampaignRequest request = new()
      {
         BaseCampaign = originalCampaignId
      };

      var response =
         (CopyCampaignResponse)service.Execute(request);

      return response.CampaignCopyId;
}

Remarks

This message requires Dynamics 365 Sales.

For the Web API use the CopyCampaign action.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the Campaign entity and access rights on the record specified in the BaseCampaign property. The following privileges are required: prvAppendActivity, prvAppendQueueItem, prvAppendToAccount, prvAppendToActivity, prvAppendToCampaign, prvAppendToContact, prvCreateActivity, prvCreateCampaign, prvCreateQueueItem, prvReadAccount, prvReadActivity, prvReadCampaign, prvReadContact, prvReadList, prvReadProduct, and prvReadSalesLiterature.

Constructors

CopyCampaignRequest()

Initializes a new instance of the CopyCampaignRequest class.

Properties

BaseCampaign

Gets or sets the ID of the base campaign to copy from. 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)
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 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)
SaveAsTemplate

Gets or sets a value that indicates whether to save the campaign as a template. Required.

Applies to

See also