AddListMembersListRequest AddListMembersListRequest AddListMembersListRequest AddListMembersListRequest Class

Definition

Contains the data that is needed to add members to the list.

For the Web API use the AddListMembersList Action.

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

Examples


// Add a list of contacts to the marketing list.
var addMemberListReq = new AddListMembersListRequest
  {
    MemberIds = new[] { _contactIdList[0], _contactIdList[2] },
    ListId = _marketingListId
  };
  
   svc.Execute(addMemberListReq);
      Console.WriteLine("  Contacts with GUIDs \r\n\t{{{0}}}\r\n\tand {{{1}}}\r\n  were added to the list.",
    _contactIdList[0], _contactIdList[1]);

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.

Marketing#DistributeCampaignFromMarketingList6

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 AddListMembersListResponse 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 MemberIds property. The caller must also have access rights on the specified records in the ListId property and the MemberIds property. For a complete list of the required privileges, see AddListMembersList message privileges.

Notes for Callers

The members that are 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

AddListMembersListRequest() AddListMembersListRequest() AddListMembersListRequest() AddListMembersListRequest()

Initializes a new instance of the AddListMembersListRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
ListId ListId ListId ListId

Gets or sets the ID of the list. Required.

MemberIds MemberIds MemberIds MemberIds

Gets or sets an array of IDs of the members that you want to add to the list. Required.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also