Copies Members into new Lists

This API let's you copy Members from a List into one or more new Lists, and optionally change the type of the List.
If the split attribute is not specified then one new List will be created and all members will be copied into that List.
If the split attribute is specified then a random sub-set of the Members will be copied into one or many new Lists. The newly created Lists always have state INSTALLED.

Path Params
string
required

The name of the space (database) assigned to you.

string
required

One of:

  • The Entity's internal Entity Id
  • The Entity's name
  • The Entity's business Id, prefixed with $
Query Params
string

The base name of the new Lists to be created. By default it uses the current List's name as base name.
Each List created will have this name but with the added _n at the end of the name. So if for example the current List is called MySubscribers and three new Lists are created, they will be called MySubscribers_1, MySubscribers_2 and MySubscribers_3.

string
enum

Controls the type of the new Lists to be created. This can be one of TAG, COUNTER and DATA.
By default, TAG, COUNTER and DATA Lists will result in new Lists matching the source List, whereas SQL Lists will generate Data Lists with the same columns, and TARGET and SUBSCRIPTION Lists will generate TAG Lists.

Allowed:
string

This powerful attribute allows multiple Lists to be generated, each containing a unique set of Random Members from the source List.
The attribute accepts a comma-separated list of splits, with each value being either a fixed count or a percentage. A '*' at the end creates one last List with all remaining Members.
For example split=50%,2000,* will produce up to 3 new Lists. The first List will contain 50% of the Members, the second List will contain 2,000 Members (if there are that many left), and any remaining Members will be added to a third List.
If this parameter is not specified, it default to 100%, so it will generate one new List containing a copy of all Members form the source List.

string

Optional Query fields used to limit the Members to be copied. Multiple fields can be specified, separated by semicolon, and wildcards are supported. This field works the same way as when querying Lists.

string

An optional identifier of who the new List should be assigned to. Defaults to the same as the existing List.

string

The Dimensions under which the calling application operates. Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json