Marketing List (List) table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Group of existing or potential customers created for a marketing campaign or other sales purposes.

Added by: Marketing Solution

Messages

Message	Web API Operation	SDK class or method
AddListMembersList		AddListMembersListRequest
AddMemberList		AddMemberListRequest
AddMembersBatchList		Type generated by Power Platform CLI pac modelbuilder build command or use OrganizationRequest setting the required parameters for the message.
Assign	PATCH /lists(listid) Update ownerid property.	AssignRequest
CopyDynamicListToStatic		CopyDynamicListToStaticRequest
CopyMembersList		CopyMembersListRequest
Create	POST /lists See Create	CreateRequest or Create
CreateActivitiesList		CreateActivitiesListRequest
CreateMultiple	CreateMultiple	CreateMultipleRequest
Delete	DELETE /lists(listid) See Delete	DeleteRequest or Delete
GrantAccess	GrantAccess	GrantAccessRequest
ModifyAccess	ModifyAccess	ModifyAccessRequest
QualifyMemberList		QualifyMemberListRequest
RemoveListMembersList		Use OrganizationRequest where RequestName = RemoveListMembersList
RemoveMemberList		RemoveMemberListRequest
Retrieve	GET /lists(listid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET /lists See Query Data	RetrieveMultipleRequest or RetrieveMultiple
RetrievePrincipalAccess	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess	RevokeAccess	RevokeAccessRequest
SetState	PATCH /lists(listid) Update statecode and statuscode properties.	SetStateRequest
Update	PATCH /lists(listid) See Update	UpdateRequest or Update
UpdateMultiple	UpdateMultiple	UpdateMultipleRequest

Properties

Property	Value
CollectionSchemaName	Lists
DisplayCollectionName	Marketing Lists
DisplayName	Marketing List
EntitySetName	lists
IsBPFEntity	False
LogicalCollectionName	lists
LogicalName	list
OwnershipType	UserOwned
PrimaryIdAttribute	listid
PrimaryNameAttribute	listname
SchemaName	List

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• Cost
• CreatedFromCode
• Description
• DoNotSendOnOptOut
• IgnoreInactiveListMembers
• ImportSequenceNumber
• LastUsedOn
• ListId
• ListName
• LockStatus
• MemberCount
• MemberType
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• processedMemberCount
• processFetchXML
• ProcessId
• Purpose
• Query
• Source
• StageId
• StateCode
• StatusCode
• TimeZoneRuleVersionNumber
• TransactionCurrencyId
• TraversedPath
• Type
• UTCConversionTimeZoneCode

Cost

Property	Value
Description	Type the cost of obtaining the marketing list.
DisplayName	Cost
IsValidForForm	True
IsValidForRead	True
LogicalName	cost
MaxValue	1000000000000
MinValue	0
Precision	2
PrecisionSource	2
RequiredLevel	None
Type	Money

CreatedFromCode

Property	Value
Description	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.
DisplayName	Marketing List Member Type
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	createdfromcode
RequiredLevel	SystemRequired
Type	Picklist

CreatedFromCode Choices/Options

Value	Label	Description
1	Account
2	Contact
4	Lead

Description

Property	Value
Description	Type additional information to describe the marketing list, such as the intended use or date of the last update.
DisplayName	Description
Format	TextArea
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	description
MaxLength	2000
RequiredLevel	None
Type	Memo

DoNotSendOnOptOut

Property	Value
Description	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.
DisplayName	Exclude Members Who Opt Out
IsValidForForm	True
IsValidForRead	True
LogicalName	donotsendonoptout
RequiredLevel	None
Type	Boolean

DoNotSendOnOptOut Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 1

IgnoreInactiveListMembers

Property	Value
Description	Select whether inactive accounts, contacts, or leads should be excluded from the campaign activity distribution when the marketing list is included in a campaign.
DisplayName	Ignore Inactive List Members
IsValidForForm	True
IsValidForRead	True
LogicalName	ignoreinactivelistmembers
RequiredLevel	None
Type	Boolean

IgnoreInactiveListMembers Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 1

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
Format	None
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	importsequencenumber
MaxValue	2147483647
MinValue	-2147483648
RequiredLevel	None
Type	Integer

LastUsedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Shows the date and time when the marketing list was last used in a campaign or in the creation of activities or opportunities.
DisplayName	Last Used On
Format	DateOnly
IsValidForCreate	False
IsValidForForm	True
IsValidForRead	True
LogicalName	lastusedon
RequiredLevel	None
Type	DateTime

ListId

Property	Value
Description	Unique identifier of the marketing list.
DisplayName	Marketing List
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	listid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ListName

Property	Value
Description	Type a name for the marketing list so that it is identified correctly in lists.
DisplayName	Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	listname
MaxLength	128
RequiredLevel	SystemRequired
Type	String

LockStatus

Property	Value
Description	Select whether the marketing list is locked. If Yes is selected, no additional members can be added to the marketing list.
DisplayName	Locked
IsValidForForm	True
IsValidForRead	True
LogicalName	lockstatus
RequiredLevel	None
Type	Boolean

LockStatus Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

MemberCount

Property	Value
Description	Shows the sum of all members in the marketing list.
DisplayName	Members Count
Format	None
IsValidForCreate	False
IsValidForForm	True
IsValidForRead	True
LogicalName	membercount
MaxValue	1000000000
MinValue	0
RequiredLevel	None
Type	Integer

MemberType

Property	Value
Description	Type of the members that can be stored in the marketing list. Please do not remove from form!
DisplayName	Member Type
Format	None
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	membertype
MaxValue	1000000000
MinValue	0
RequiredLevel	None
Type	Integer

OverriddenCreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time that the record was migrated.
DisplayName	Record Created On
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime

OwnerId

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Targets	systemuser,team
Type	Owner

OwnerIdType

Added by: Active Solution Solution

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridtype
RequiredLevel	SystemRequired
Type	EntityName

processedMemberCount

Added by: Marketing Patch 05/2019 Solution

Property	Value
Description
DisplayName	processedMemberCount
Format	None
IsValidForForm	True
IsValidForRead	True
LogicalName	processedmembercount
MaxValue	2147483647
MinValue	-2147483648
RequiredLevel	None
Type	Integer

processFetchXML

Added by: Marketing Patch 05/2019 Solution

Property	Value
Description
DisplayName	processFetchXML
Format	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	processfetchxml
MaxLength	10000
RequiredLevel	None
Type	Memo

ProcessId

Property	Value
Description	Contains the id of the process associated with the entity.
DisplayName	Process Id
IsValidForForm	False
IsValidForRead	True
LogicalName	processid
RequiredLevel	None
Type	Uniqueidentifier

Purpose

Property	Value
Description	Type the intended use of the marketing list to identify its key segments, target offers, or business group.
DisplayName	Purpose
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	purpose
MaxLength	512
RequiredLevel	None
Type	String

Query

Property	Value
Description	Query used for retrieving members of marketing list.
DisplayName	Query
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	query
MaxLength	1073741823
RequiredLevel	None
Type	String

Source

Property	Value
Description	Type the source of the marketing list, such as a third-party supplier or internal database.
DisplayName	Source
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	source
MaxLength	128
RequiredLevel	None
Type	String

StageId

Property	Value
Description	Contains the id of the stage where the entity is located.
DisplayName	(Deprecated) Stage Id
IsValidForForm	False
IsValidForRead	True
LogicalName	stageid
RequiredLevel	None
Type	Uniqueidentifier

StateCode

Property	Value
Description	Shows whether the marketing list is active or inactive. Inactive marketing lists are read-only and can't be edited unless they are reactivated.
DisplayName	Status
IsValidForCreate	False
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

StateCode Choices/Options

Value	Label	DefaultStatus	InvariantName
0	Active	0	Active
1	Inactive	1	Inactive

StatusCode

Property	Value
Description	Select the marketing list's status.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status

StatusCode Choices/Options

Value	Label	State
0	Active	0
1	Inactive	1

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

TransactionCurrencyId

Property	Value
Description	Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName	Currency
IsValidForForm	True
IsValidForRead	True
LogicalName	transactioncurrencyid
RequiredLevel	None
Targets	transactioncurrency
Type	Lookup

TraversedPath

Property	Value
Description	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.
DisplayName	(Deprecated) Traversed Path
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	traversedpath
MaxLength	1250
RequiredLevel	None
Type	String

Type

Property	Value
Description	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
DisplayName	Type
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	type
RequiredLevel	SystemRequired
Type	Boolean

Type Choices/Options

Value	Label	Description
1	Dynamic
0	Static

DefaultValue: 0

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• Cost_Base
• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ExchangeRate
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningBusinessUnitName
• OwningTeam
• OwningUser
• TransactionCurrencyIdName
• VersionNumber

Cost_Base

Property	Value
Description	Value of the Cost in base currency.
DisplayName	Cost (Base)
IsValidForForm	True
IsValidForRead	True
LogicalName	cost_base
MaxValue	922337203685477
MinValue	-922337203685477
Precision	4
PrecisionSource	2
RequiredLevel	None
Type	Money

CreatedBy

Property	Value
Description	Shows who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyyominame
MaxLength	100
RequiredLevel	None
Type	String

CreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was created.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime

CreatedOnBehalfBy

Property	Value
Description	Shows who created the record on behalf of another user.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

ExchangeRate

Added by: Active Solution Solution

Property	Value
Description	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.
DisplayName	Exchange Rate
IsValidForForm	True
IsValidForRead	True
LogicalName	exchangerate
MaxValue	100000000000
MinValue	0.000000000001
Precision	12
RequiredLevel	None
Type	Decimal

ModifiedBy

Property	Value
Description	Shows who last updated the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyyominame
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was modified.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime

ModifiedOnBehalfBy

Property	Value
Description	Shows who last updated the record on behalf of another user.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

OwnerIdName

Property	Value
Description	Name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdYomiName

Property	Value
Description	Yomi name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwningBusinessUnit

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	SystemRequired
Targets	businessunit
Type	Lookup

OwningBusinessUnitName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owningbusinessunitname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwningTeam

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	owningteam
RequiredLevel	None
Targets	team
Type	Lookup

OwningUser

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Targets	systemuser
Type	Lookup

TransactionCurrencyIdName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	transactioncurrencyidname
MaxLength	100
RequiredLevel	None
Type	String

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

One-To-Many Relationships

Listed by SchemaName.

List_BulkOperations

Same as the List_BulkOperations many-to-one relationship for the bulkoperation table/entity.

Property	Value
ReferencingEntity	bulkoperation
ReferencingAttribute	regardingobjectid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	List_BulkOperations
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order:
CascadeConfiguration	Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade

Many-To-Many Relationships

Relationship details provided where the List table is the first table in the relationship. Listed by SchemaName.

• campaignactivitylist_association
• campaignlist_association
• listcontact_association
• listlead_association
• listaccount_association

campaignactivitylist_association

See the campaignactivitylist_association many-to-many relationship for the campaignactivity table/entity.

campaignlist_association

See the campaignlist_association many-to-many relationship for the campaign table/entity.

listcontact_association

IntersectEntityName: listmember

Table 1

Property	Value
IntersectAttribute	listid
IsCustomizable	False
LogicalName	list
NavigationPropertyName	listcontact_association
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Marketing Label: Order: 10

Table 2

Property	Value
LogicalName	contact
IntersectAttribute	entityid
NavigationPropertyName	listcontact_association
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Details Label: Order:

listlead_association

IntersectEntityName: listmember

Table 1

Property	Value
IntersectAttribute	listid
IsCustomizable	False
LogicalName	list
NavigationPropertyName	listlead_association
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Marketing Label: Order: 10

Table 2

Property	Value
LogicalName	lead
IntersectAttribute	entityid
NavigationPropertyName	listlead_association
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Details Label: Order:

listaccount_association

IntersectEntityName: listmember

Table 1

Property	Value
IntersectAttribute	listid
IsCustomizable	False
LogicalName	list
NavigationPropertyName	listaccount_association
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Marketing Label: Order: 10

Table 2

Property	Value
LogicalName	account
IntersectAttribute	entityid
NavigationPropertyName	listaccount_association
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Details Label: Order:

See also

Dataverse table/entity reference
Web API Reference