AddMemberListRequest Class

  • Reference

Definition

Namespace:
Microsoft.Crm.Sdk.Messages
Assembly:
Microsoft.Crm.Sdk.Proxy.dll
Package:
Microsoft.PowerPlatform.Dataverse.Client v1.0.1

Contains the data that is needed to add a member to a list (marketing list).

For the Web API use the AddMemberList Action.

public ref class AddMemberListRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class AddMemberListRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type AddMemberListRequest = class
    inherit OrganizationRequest
Public NotInheritable Class AddMemberListRequest
Inherits OrganizationRequest
Inheritance
Object
OrganizationRequest
AddMemberListRequest
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. For the complete sample, see the link later in this topic.

List newList = new List()
{
    ListName = "TestList", 
    CreatedFromCode = new OptionSetValue((int)ListCreatedFromCode.Account)
};

_newListId = _serviceProxy.Create(newList);

for (int j = 0; j < 5; j++)
{
    AddMemberListRequest addMemberListRequest = new AddMemberListRequest();
    addMemberListRequest.EntityId = _accountIdArray[j];
    addMemberListRequest.ListId = _newListId;
    AddMemberListResponse addMemberListResponse = 
        _serviceProxy.Execute(addMemberListRequest) as AddMemberListResponse;
}

Guid BOId = CreateAndRetrieveQuickCampaignForMarketingList(
    _templateLetterActivity, 
    _newListId, 
    PropagationOwnershipOptions.ListMemberOwner, 
    true);

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(OrganizationRequest) method, which returns an instance of the AddMemberListResponse class.

Privileges and Access Rights

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

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

Notes for Callers

A member that is added to the list must be of the same type: Account, Contact, or Lead. For example, you cannot add accounts and contacts to the same list.

Constructors

AddMemberListRequest()

Initializes a new instance of the AddMemberListRequest class.

Properties

EntityId

Gets or sets the ID of the member you want to add to the list. 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)
ListId

Gets or sets the ID of the list. 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)

Applies to

See also