Save a Step

post https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/funnels/{funnelLookupId}/steps

This operation moves a Member forward in the funnel by saving the next step.
Note that the step is by default only saved (and any triggers executed) if the Member is new to the Funnel or if the Step is higher
than the Member's current position in the Funnel. Otherwise the call is simply ignored.

This behaviour can be overridden by specifying the saveOld=true attribute, in which case older steps will be saved as well (if they don't already exist).
Note that triggers are not executed if an older step is saved.

Path Params

space

string

required

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

funnelLookupId

string

required

One of:

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

Query Params

saveOld

boolean

Defaults to false

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).

funnelId

string

The Funnel entity Id

step

string

The id of the step as per the funnel definition. Mandatory.

reached

date-time

The timestamp when the step was reached. Not normally specified as it defaults to the current timestamp, but may be overriden for example during batch imports.

Response

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://neon-loyalty-qa.spika.com/loyalty/v1/space/funnels/funnelLookupId/steps?saveOld=false&response=false' \
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