Creates a step in a paused flow

Adds a step without content at the end of a paused flow and returns it. The step is upcoming, and has no role unless one is given: a paused flow cannot be resumed while one of its upcoming steps is empty or has no role. A role that had finished all its steps is back in progress once it receives the step.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Flow ID

Body Params

Step attributes

string
required
string
string
length ≤ 30
string

ID of a role of the flow whose access was not revoked

string
enum

How the step ends when its role is external. external: the participant completes the step; internal: the participant completes the step, then a team member reviews it; external_review: the participant approves what the step shares, or asks for changes. A step that shares something (note, link, embed, file) accepts external and external_review, a step that asks for something (form, todo, file_request) accepts external and internal. A step goes back to external when it receives a content that does not accept its rule.

Allowed:
integer
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json