list EntityType

Entity Set Path
[organization URI]/api/data/v9.0/lists
Base Type
crmbaseentity
Display Name
Marketing List
Primary Key
listid
Primary Key Attribute
listname
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
cost Edm.Decimal

Type the cost of obtaining the marketing list.

Display Name: Cost

cost_base Edm.Decimal

Value of the Cost in base currency.

Display Name: Cost (Base)

Read Only
createdfromcode Edm.Int32

Select the type of members that this marketing list will contain: accounts, contacts, or leads. Each list can have only one member type and this value can't be changed after the marketing list is created.

Display Name: Marketing List Member Type

Default Options
Value Label
1 Account
2 Contact
4 Lead
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
description Edm.String

Type additional information to describe the marketing list, such as the intended use or date of the last update.

Display Name: Description

donotsendonoptout Edm.Boolean

Select whether to override the opt-out settings on leads, contacts, and accounts for the members of the target marketing lists of the campaign activity. If No is selected, those who have chosen to opt out won't be excluded from the list. This means they will receive marketing materials.

Display Name: Exclude Members Who Opt Out

Default Options
Value Label
1 Yes
0 No
exchangerate Edm.Decimal

Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.

Display Name: Exchange Rate

Read Only
ignoreinactivelistmembers Edm.Boolean

Select whether inactive accounts, contacts, or leads should be excluded from the campaign activity distribution when the marketing list is included in a campaign.

Display Name: Ignore Inactive List Members

Default Options
Value Label
1 Yes
0 No
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

lastusedon Edm.DateTimeOffset

Shows the date and time when the marketing list was last used in a campaign or in the creation of activities or opportunities.

Display Name: Last Used On

listid Edm.Guid

Unique identifier of the marketing list.

Display Name: List

listname Edm.String

Type a name for the marketing list so that it is identified correctly in lists.

Display Name: Name

lockstatus Edm.Boolean

Select whether the marketing list is locked. If Yes is selected, no additional members can be added to the marketing list.

Display Name: Locked

Default Options
Value Label
1 Yes
0 No
membercount Edm.Int32

Shows the sum of all members in the marketing list.

Display Name: Members Count

membertype Edm.Int32

Type of the members that can be stored in the marketing list.

Display Name: Member Type

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

processid Edm.Guid

Contains the id of the process associated with the entity.

Display Name: Process Id

purpose Edm.String

Type the intended use of the marketing list to identify its key segments, target offers, or business group.

Display Name: Purpose

query Edm.String

Query used for retrieving members of marketing list.

Display Name: Query

source Edm.String

Type the source of the marketing list, such as a third-party supplier or internal database.

Display Name: Source

stageid Edm.Guid

Contains the id of the stage where the entity is located.

Display Name: Stage Id

statecode Edm.Int32

Shows whether the marketing list is active or inactive. Inactive marketing lists are read-only and can't be edited unless they are reactivated.

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Select the marketing list's status.

Display Name: Status Reason

Default Options
Value Label
0 Active
1 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

traversedpath Edm.String

A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.

Display Name: Traversed Path

type Edm.Boolean

Select whether you want the marketing list to be static or dynamic. The members in a static marketing list are unchanging. A dynamic marketing list is based on a dynamic query that retrieves the updated list of members

Display Name: Type

Default Options
Value Label
1 Dynamic
0 Static
utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Shows who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_transactioncurrencyid_value transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_list_createdby
createdonbehalfby systemuser lk_list_createdonbehalfby
modifiedby systemuser lk_list_modifiedby
modifiedonbehalfby systemuser lk_list_modifiedonbehalfby
ownerid principal owner_lists
owningbusinessunit businessunit business_unit_list
owningteam team team_list
owninguser systemuser user_list
stageid_processstage processstage processstage_lists
transactioncurrencyid transactioncurrency transactioncurrency_list

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
campaignactivitylist_association campaignactivity campaignactivitylist_association
campaignlist_association campaign campaignlist_association
List_Annotation annotation objectid_list
List_AsyncOperations asyncoperation regardingobjectid_list
List_BulkDeleteFailures bulkdeletefailure regardingobjectid_list
List_BulkOperations bulkoperation regardingobjectid_list
list_connections1 connection record1id_list
list_connections2 connection record2id_list
List_DuplicateBaseRecord duplicaterecord baserecordid_list
List_DuplicateMatchingRecord duplicaterecord duplicaterecordid_list
list_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_list
list_principalobjectattributeaccess principalobjectattributeaccess objectid_list
List_ProcessSessions processsession regardingobjectid_list
List_SyncErrors syncerror regardingobjectid_list_syncerror
listaccount_association account listaccount_association
listcontact_association contact listcontact_association
listlead_association lead listlead_association

Operations

The following operations can be used with the list entity type.

Name Binding
AddItemCampaign Entity
AddListMembersList Not Bound
AddMemberList Entity
CopyDynamicListToStatic Entity
CopyMembersList Entity
CreateActivitiesList Not Bound
GrantAccess Not Bound
ModifyAccess Not Bound
QualifyMemberList Entity
RemoveMemberList Entity
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the list entity type.

Name Description
Marketing Dynamics 365 workload for marketing and enterprise.
Marketing Sales For internal use only.

See Also