Dots home pagelight logo
  1. Flow Routes
  2. Create Flow
POST

/api/v2/flows

client_id*
api_key*
curl --request POST \
     --url https://api.senddotssandbox.com/api/v2/flows \
     --header 'Authorization: Basic AUTH_VALUE' \
     --header 'Content-Type: application/json' \
     --data '{
 "steps": "array"
}'

​
Body

stepsRequired
array

A list of steps. Can either be a string or an object with additional properties. Example: A redirect step looks like {"name": "redirect", "redirect_url": "https://example.com"}

user_id
string

The user's id.

metadata
string | object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
Response

id
string

ID of the flow.

created
string

Date that the flow was created.

user_id
string | null

ID of the user that has claimed the flow.

steps
string[]

Array of steps in the flow.

completed_steps
string[]

Array of steps that have been completed in the flow.

link
string

URL to access the flow. Can be embedded in an iframe.

metadata
string | object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.