Save List Item

post

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

Add, update or remove a List item.

The following actions can be specified:

SET (default if no action is specified)
Inserts or updates a Member in a List.
When updating a Counter List, it increases or decreases the counter with the specified value, unless the replaceCounters attribute is set.
When updating a Data List, only the fields specified in the updateColumns will be updated, leaving any other columns untouched.
ADD_ONLY
Inserts a List Item if it doesn't already exist, but does NOT update the List Item if it already exists.
This option is not applicable to Tag Lists.
UPDATE_ONLY
Updates an existing List Item, but does NOT create it if it doesn't already exist.
This option is not applicable to Tag Lists.
When updating a Counter List, it increases or decreases the counter with the specified value, unless the replaceCounters attribute is set.
When updating a Data List, only the fields specified in the updateColumns will be updated, leaving any other columns untouched.
REMOVE
Removes the List Item. For Tag Lists this is the opposite of SET.
This operation is not applicable for Subscription Lists.

The updateColumns must be used together with SET and UPDATE_ONLY for Data Lists to control exactly which fields get updated. It contains a comma-separated list of columns. A special value '\*' (just a star) can be used to refer to all fields.

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

action

string

enum

List Save Action. Default is SET, which creates the List record if it doesn't already exists, and updates it if it exists. ADD_ONLY, will add a add the Member to the List if it doesn't already exist, but will not update an existing List. UPDATE_ONLY is the opposite. REMOVE will remove the passed in Members from the List if they exist. In this case, it's enough to pass in the Member Lookup Id, since all other fields will be ignored.

Allowed:

updateColumns

string

Only used for Data Lists, and only when the save action is either SET or UPDATE_ONLY. In those cases the attribute is mandatory. Contains a comma-separated list of the columns to be updated. If set to "*" then all columns in the table will be updated, setting any non-specified values to null.
This attributes allows SET operations to add rows if the Member doesn't exist in the list, but only update some of the columns if the Member already existed.

replaceCounters

boolean

Only used for Counter Lists and only with the save actions SET and UPDATE_ONLY. If true then the Counter values will be replaced with the specified values. If false or not specified, then any existing Counter values will be increased or decreased with the specified values.

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

boolean

Defaults to false

If true, returns the saved content/resource. If false, the response content tag is not populated. Only set to true when the response payload is needed.

Body Params

memberId

string

When querying, returns Member Id. When saving also accepts member Lookup Id (email etc).

listId

string

The list Id

subscriptionState

string

enum

Only for Subscription Lists. Hold's the subscription state

Allowed:

counter

int32

Only for Counter Lists.

data

object

Holds the data columns for Data Lists and SQL Lists.

Response

200OK