Condividi tramite

AddListMembersListRequest Class

  • Reference

Definition

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

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

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
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type AddListMembersListRequest = class
    inherit OrganizationRequest
Public NotInheritable Class AddListMembersListRequest
Inherits OrganizationRequest
Inheritance
Object
OrganizationRequest
AddListMembersListRequest
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 AddListMembers message
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
/// <param name="contactIdList">An array of contact record IDs to add to the list</param>
/// <param name="marketingListId">The ID of the marketing list</param>
static void AddListMembersListExample(IOrganizationService service, 
      Guid[] contactIdList, 
      Guid marketingListId) {

      // Add a list of contacts to the marketing list.
      var addMemberListReq = new AddListMembersListRequest
      {
         MemberIds = new[] { contactIdList[0], contactIdList[1] },
         ListId = marketingListId
      };

      service.Execute(addMemberListReq);

      Console.WriteLine("Contacts with GUIDs \r\n\t{{{0}}}\r\n\tand {{{1}}}  were added to the list.",
         contactIdList[0], contactIdList[1]);

      Console.WriteLine($"Contacts with IDs " +
         $"\r\n\t{contactIdList[0]} and " +
         $"\r\n\t{contactIdList[1]}\r\n " +
         $"were added to the list.");
}

Remarks

This message requires Dynamics 365 Sales.

For the Web API use the AddListMembersList action.

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 table and on the record specified in the MemberIds property. The caller must also have access rights on the specified records in the ListId property and the MemberIds property.

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

Initializes a new instance of the AddListMembersListRequest class.

Properties

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.

MemberIds

Gets or sets an array of IDs of the members that you want to add to 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 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)

Applies to

See also