Start a Journey

post

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

Path Params

space

string

required

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

journeyLookupId

string

required

One of:

Query Params

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.

Body Params

memberId

string

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

journeyId

string

The Journey entity Id

state

string

enum

Allowed:

data

object

Any data attributes set when the Journey was entered

steps

array of objects

The steps the member has entered. The stepId is the key.

steps

Response

Language

Credentials

Header

Response

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

application/json

200OK