Update User Flow State

Authorizations

Authorization

string

headerrequired

Authentication header of the form Bearer: <token>, where <token> is either your public or private API key. See when to use which

Body

application/json

userId

string

required

The ID of the user

flowSlug

string

required

The Flow Slug

actionType

enum<string>

required

The type of action the user took

Available options:

STARTED_STEP,

COMPLETED_STEP,

SKIPPED_STEP,

NOT_STARTED_STEP,

STARTED_FLOW,

COMPLETED_FLOW,

SKIPPED_FLOW,

NOT_STARTED_FLOW

groupId

string

Optional ID of the group

stepId

string

The Step ID if updating a specific Step

data

string

Any optional data including the user action

Response

201 - application/json

eligibleFlows

object[]

List of Flows that the user is eligible for as well as the user's state in each Flow

ineligibleFlows

string[]

List of Flow IDs that the user is ineligible for (for instance if a Flow is turned off)

API

Flows

Users

Groups

Update User Flow State

Authorizations

Body

Response