This will be used for creating virtual list. Its primary use would be creating new virtual list based on templateList using ruleSetGroup(group of rule sets of type filter) on source list (existing physical list).

Input

org: orgType and internalId

templateList: externalId and type

sourceList:internalId or externalId

ruleSetGroup:internalId or externalId

Response

List (D)

Availability

Engage 11.12

Errors returned

ARG_NULL – Argument supplied is null

ATTRIBUTE_INVALID_TYPE - Attribute is invalid type

ATTRIBUTE_INVALID_Data - Attribute has invalid data

ATTRIBUTE_NULL – Attribute supplied is null

OBJECT_EXISTS – Object '%s' already exists

OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

SYSTEM_LIMIT_EXCEEDED – maximum number of active lists exceeded

Notes

deleteList(List list)

Deletes a list.

Input

list: internalId

Response

NONE

Availability

Engage 7.5.0, Insight 1.3

Errors returned

ARG_NULL – Invalid Data, argument '%s' must be non-null

ATTRIBUTE_NULL – Attribute supplied is null

OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

Delete list can be called on a non-empty list (a list with contacts), which deletes the list and the associated contacts.

showList(List list)

Retrieves information about the supplied List.

Input

list: internalId

Response

List (D)

Availability

Engage 7.5.0

Errors returned

ARG_NULL – Invalid Data, argument '%s' must be non-null

ATTRIBUTE_NULL – Attribute supplied is null

OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

listLists(BaseEntity baseEntity, List sample)

Lists lists associated with the identified entity.

Input

baseEntity: externalId or internalId, and if baseEntity is an Org, type must also be specified.

sample: optional list object to narrow the returned set.

Response

List[] (K)

Availability

Engage 7.5.0, Insight 1.3

Errors returned

ARG_INVALID_TYPE – Argument is of invalid type '%s'

ARG_NULL – Invalid Data, argument '%s' must be non-null

ATTRIBUTE_NULL – One of externalId or internalId must be non-null on the baseEntity

OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

RESULT_TOO_LARGE – Result returned would be too large

Notes

The maximum number of items returned using this method is 1,000.

Only the attributes on the core entity are matched if a sample is supplied.

The supplied BaseEntity must be a valid Account, Enterprise, or Campaign.