Save a Member

post

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

Adds or replaces a Member. If the Member's Id is specified it will be updated, otherwise it will be added.

Consider using /forms/ endpoints instead.

Path Params

space

string

required

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

Query Params

dim

string

Optional dimensions to assign to the creation of the Member. Ignored when a Member is updated.

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

The core Member object, containing States for the platform to operate correctly.

Profile information is Stored separately in a DataList.

string

The unique platform id for the Member. This is case sensitive and is generated automatically when the Member is first created. It cannot be set or changed.

bizId

string

length ≤ 50

Optional unique additional identifier to tie the Member to the business' platform. Case sensitive.

state

string

enum

required

The Member's state in the NEON platform.

Allowed:

optinState

string

enum

required

Set to IN if the Member has opted in for marketing communication

Allowed:

string

length between 5 and 100

The core email address, used by any emails sent directly by NEON. The email address may or may not be required and may or may not need to be unique depending on the configuration.

emailState

string

enum

Allowed:

mobile

string

length between 5 and 20

The core mobile number, used by any mobile messages sent directly by NEON.

The mobile may or may not be required and may or may not need to be unique depending on the configuration.

The mobile number must be specified in full international format starting with the '+' sign.

mobileState

string

enum

Allowed:

200OK