Save Sheet Row

post https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/sheets/{sheetLookupId}/rows

Add or update a single row in a Sheet.

The following actions can be specified:

SET (default if no action is specified)
Inserts or updates a Sheet row.
When updating a Data or Member Sheet, the updateColumns attribute controls which fields are updated.
Note: This action is not allowed for Sheets with generated keys.
ADD_ONLY
Inserts a Sheet row if it doesn't already exist, but does NOT update the row if it already exists.
UPDATE_ONLY
Updates an existing Sheet row, but does NOT create it if it doesn't already exist.
When updating a Data or Member Sheet, the updateColumns attribute controls which fields get updated.
REMOVE
Removes the Sheet row. Only the key fields need top be passed in.

The updateColumns attribute must be used together with SET and UPDATE_ONLY for Data Sheets and Member Sheets to control which columns get updated. It contains a comma-separated list of the columns to update. Specify '\*' (just star) to update all columns.

For Member sheets, there must always be one attribute called member_id. This can contain any MemberLookupId type (email, business Id etc).

Path Params

space

string

required

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

sheetLookupId

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

required

updateColumns

string

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

key

string

Used for Property Sheets to set and get the property name.

For all other Sheet types, this field is read-only and contains the full key of the row as a comma-separated list of values. In the case of Member Sheets, the list starts with the Memeber Id

value

string

Only for Property Sheets to set and get the property value.

description

string

Only for Property Sheets: Optional description of what the property is for.

data

object

Only for Data and Member Sheets: Holds all columns including the keys.

For Member Sheets the first part of the key is always the member_id field. When saving Member Sheets, this column supports MemberLookupIds, which will be converted into Member Id.

Response

xxxxxxxxxx
curl --request POST \
     --url 'https://neon-loyalty-qa.spika.com/loyalty/v1/space/sheets/sheetLookupId/rows?action=SET&response=false' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

200OK