List (marketing list) entity messages and methods

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

A list for a sales or marketing campaign contains records of one specified entity type such as contacts, leads, or accounts. A list member is a contact, lead, or account that is added to a list.

The schema name for this entity is List. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AddListMembersListRequest	Adds a list of members to a list.
AddMemberListRequest	Adds a member to a list.
AssignRequest	Assigns a list to another user or team.
CopyDynamicListToStaticRequest	Creates a static list from the specified dynamic list and adds the members that satisfy the dynamic list query criteria to the static list.
CopyMembersListRequest	Copies the members from the source list to the target list without creating duplicates.
CreateRequest	Creates a list. You can also call the IOrganizationService.Create method.
CreateActivitiesListRequest	Creates a quick campaign for a specified marketing list.
DeleteRequest	Deletes a list. You can also call the IOrganizationService.Delete method.
GrantAccessRequest	Shares a list with another security principal (user or team).
ModifyAccessRequest	Changes the access rights for a list previously shared with another security principal (user or team).
QualifyMemberListRequest	Qualifies the specified member list and either overrides the list members or removes them.
RemoveMemberListRequest	Removes a member from a list.
RetrieveRequest	Retrieves a list. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of lists. You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access rights that the specified security principal (user or team) has to a list.
RetrieveSharedPrincipalsAndAccessRequest	Retrieves the security principals (users or teams) that have access to a list, together with their access rights to the list.
RevokeAccessRequest	Removes all access rights to a list for the specified security principal (user or team).
SetStateRequest	Sets the state of a list. If you are using early bound types, use the ListState enumeration to set the possible states. For a list of the state values, refer to the list entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
UpdateRequest	Updates a list. You can also call the IOrganizationService.Update method.

See Also

List (marketing list) entity
Privileges by entity

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright