Dela via


list EntityType

 

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

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

Entity Set path:[organization URI]/api/data/v8.2/lists

Base Type: crmbaseentity EntityType

Display Name: Marketing List

Primary Key: listid

Primary Name Attribute: listname

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to list

Operations using the list entity type.

Properties

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

Name

Type

Details

cost

Edm.Decimal

Description: Type the cost of obtaining the marketing list.

Display Name: Cost

cost_base

Edm.Decimal

Description: Shows the Cost field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Cost (Base)

Read-only property

createdfromcode

Edm.Int32

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.

Default Options:

1 : Account
2 : Contact
4 : Lead

Display Name: Marketing List Member Type

createdon

Edm.DateTimeOffset

Description: Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read-only property

description

Edm.String

Description: 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

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.

Default Options:

1 : Yes
0 : No

Display Name: Exclude Members Who Opt Out

exchangerate

Edm.Decimal

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.

Display Name: Exchange Rate

Read-only property

ignoreinactivelistmembers

Edm.Boolean

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.

Default Options:

1 : Yes
0 : No

Display Name: Ignore Inactive List Members

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

lastusedon

Edm.DateTimeOffset

Description: 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

Read-only property

listid

Edm.Guid

Description: Unique identifier of the marketing list.

Display Name: List

listname

Edm.String

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

Display Name: Name

lockstatus

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Locked

membercount

Edm.Int32

Description: Shows the sum of all members in the marketing list.

Display Name: Members Count

Read-only property

membertype

Edm.Int32

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

Display Name: Member Type

modifiedon

Edm.DateTimeOffset

Description: Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read-only property

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

processid

Edm.Guid

Description: Shows the ID of the process.

Display Name: Process

purpose

Edm.String

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

Display Name: Purpose

query

Edm.String

Description: Query used for retrieving members of marketing list.

Display Name: Query

source

Edm.String

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

Display Name: Source

stageid

Edm.Guid

Description: Shows the ID of the stage.

Display Name: Process Stage

statecode

Edm.Int32

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.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Select the marketing list's status.

Default Options:

0 : Active
1 : Inactive

Display Name: Status Reason

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

traversedpath

Edm.String

Description: For internal use only.

Display Name: Traversed Path

type

Edm.Boolean

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

Default Options:

1 : Dynamic
0 : Static

Display Name: Type

utcconversiontimezonecode

Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

versionnumber

Edm.Int64

Description: Version number of the marketing list.

Display Name: Version Number

Read-only property

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

Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.

_owningbusinessunit_value

owningbusinessunit

Unique identifier of the business unit that owns the marketing list.

_owningteam_value

owningteam

Unique identifier of the team who owns the marketing list.

_owninguser_value

owninguser

Unique identifier of the user who owns the marketing list.

_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 EntityType

lk_list_createdby

createdonbehalfby

systemuser EntityType

lk_list_createdonbehalfby

modifiedby

systemuser EntityType

lk_list_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_list_modifiedonbehalfby

ownerid

principal EntityType

owner_lists

owningbusinessunit

businessunit EntityType

business_unit_list

owningteam

team EntityType

team_list

owninguser

systemuser EntityType

user_list

stageid_processstage

processstage EntityType

processstage_lists

transactioncurrencyid

transactioncurrency EntityType

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 EntityType

campaignactivitylist_association

campaignlist_association

campaign EntityType

campaignlist_association

List_Annotation

annotation EntityType

objectid_list

List_AsyncOperations

asyncoperation EntityType

regardingobjectid_list

List_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_list

List_BulkOperations

bulkoperation EntityType

regardingobjectid_list

list_connections1

connection EntityType

record1id_list

list_connections2

connection EntityType

record2id_list

List_DuplicateBaseRecord

duplicaterecord EntityType

baserecordid_list

List_DuplicateMatchingRecord

duplicaterecord EntityType

duplicaterecordid_list

List_SyncErrors

syncerror EntityType

regardingobjectid_list_syncerror

listaccount_association

account EntityType

listaccount_association

listcontact_association

contact EntityType

listcontact_association

listlead_association

lead EntityType

listlead_association

Operations bound to list

The following operations are bound to the list entity type.

Name

Bound to

AddItemCampaign Action

Entity

AddMemberList Action

Entity

CopyDynamicListToStatic Action

Entity

CopyMembersList Action

Entity

QualifyMemberList Action

Entity

Operations using the list entity type.

The following operations use the list entity type in a parameter or return type.

Name

How used

Description

AddItemCampaign Action

entity Parameter

Adds an item to a campaign.

AddListMembersList Action

List Parameter

Adds members to a list.

AddMemberList Action

entity Parameter

Adds a member to a list (marketing list).

CopyDynamicListToStatic Action

entity Parameter

Creates a static list from the specified dynamic list and add the members that satisfy the dynamic list query criteria to the static list.

CopyDynamicListToStatic Action

ReturnType

Creates a static list from the specified dynamic list and add the members that satisfy the dynamic list query criteria to the static list.

CopyMembersList Action

entity Parameter

Copies the members from the source list to the target list without creating duplicates.

CopyMembersList Action

TargetList Parameter

Copies the members from the source list to the target list without creating duplicates.

QualifyMemberList Action

entity Parameter

Qualifies the specified list and either override the list members or remove them according to the specified option.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright