Remove List Members

post https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/lists/{listLookupId}/actions/remove-members

Removes Members from a List, along with all their List data.

This operation is only supported for Tag Lists, Counter Lists and Data Lists.

For Tag Lists this method truncates the List so that no members are left, for Data and Counter Lists
it's possible to specify query parameters to control which Members should be deleted.

Path Params

space

string

required

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

listLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

Query Params

qry

string

Optional Query fields used to limit the rows to be deleted. Multiple fields can be specified, separated by semicolon, and wildcards are supported.
This field works the same way as when querying Lists. The field applies to Data and Counter Lists.

countTotals

boolean

Defaults to false

Real-time counts and returns the totals of the source and target Lists before and after the operation.

Note, this operation can be very slow for large Lists so should only be used for testing purpose or for small lists.

dim

string

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

includeUnpublished

boolean

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

Response

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://neon-loyalty-qa.spika.com/loyalty/v1/space/lists/listLookupId/actions/remove-members?countTotals=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK