AddListMembersListRequest Class

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

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

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class AddListMembersListRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class AddListMembersListRequest : OrganizationRequest

Example

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.

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

_serviceProxy.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]);

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

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.AddListMembersListRequest

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

AddListMembersListRequest Class

Syntax

Example

Remarks

Inheritance Hierarchy

Thread Safety

Platforms

Development Platforms

Target Platforms

Change History

See Also

Reference

Other Resources

Additional resources