Update User Flow State

Authorizations

Authorization

string

header

required

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

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

flowSlug

string

required

The Flow Slug

userId

string

required

The ID of the user

data

string

Any optional data including the user action

groupId

string

Optional ID of the group

stepId

string

The Step ID if updating a specific Step

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

eligibleFlows.$state

object

The user's state in the Flow

eligibleFlows.data

object

The Flow's metadata including the user's state in each step

eligibleFlows.flowName

string

The Flow Name

eligibleFlows.flowSlug

string

The Flow Slug

eligibleFlows.flowType

string

The Flow Type

eligibleFlows.version

number

The version number of the 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