Flows
Update User Flow State
Flows
Update User Flow State
Updates the user’s state in a single Flow
POST
/
v1
/
public
/
flowStates
Authorizations
Authorization
string
headerrequiredAuthentication header of the form Bearer: <token>, where <token> is your public or private Frigade API key
Body
application/json
userId
string
requiredThe ID of the user
groupId
string
Optional ID of the group
flowSlug
string
requiredThe Flow Slug
stepId
string
The Step ID if updating a specific Step
data
string
Any optional data including the user action
actionType
enum<string>
requiredThe 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 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)