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:

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

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

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

Response body

object

memberId

string

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

memberInfo

object

Additional information about the Member.

bizId

string

length ≤ 100

The optional unique additional Member Id, usually referencing the business' member database

state

string

required

length ≤ 20

The Member's NEON state, for example ACTIVE, TEMP, BLOCKED etc

category

string

The Entity category, if specified

state

string

QUEUING ASLEEP RUNNING COMPLETED FAILED

dimensions

object

The Dimensions used to enter this Journey

Has additional fields

data

object

Any data attributes set when the Journey was entered

currentStep

string

The state currently being executed, or is about to be executed

joinedJourney

date-time

When the Journey was last started

reachedCurrentStep

date-time

When the current step was last started. Empty if the current step hasn't yet started

steps

array of objects

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

steps

object

step

string

required

The id of the step as per the Journey definition.

firstEntered

date-time

The timestamp of the first time the step was reached.

lastEntered

date-time

The timestamp of the latest time the step was reached. Only relevant for Journeys where the Member can execute multiple times

firstFinished

date-time

The timestamp of the first time the step was completed.

lastFinished

date-time

The timestamp of the latest time the step was completed. Only relevant for Journeys where the Member can execute multiple times

completed

date-time

The timestamp when the step was left. This is set automatically when the next step is entered or the member gets cancelled

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://neon-loyalty-qa.spika.com/loyalty/v1/space/journeys/journeyLookupId/members \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200OK