Skip to main content
POST
Create flow as a draft

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Headers

Idempotency-Key
string

Unique key for the operation. Repeating the same key with the same body returns the original response instead of running it again.

Body

application/json
name
string
required
Required string length: 1 - 256
trigger
object
required

Flow trigger, as listed in the catalog.

start
string
required

Block key: lowercase letters, digits, and underscores, starting with a letter.

Pattern: ^[a-z][a-z0-9_]{0,63}$
Example:

"wait_1_day"

nodes
object[]
required
Required array length: 1 - 50 elements

Branches on a field of the trigger's data.

description
string
Maximum string length: 2000
validate_only
boolean
default:false

When true, only validates the flow and returns the outline, saving nothing.

Response

Flow validated or saved as a draft.

object
string
required
Allowed value: "flow_draft"
validate_only
boolean
required

true when the flow was only validated; nothing was saved.

status
string
required
Allowed value: "draft"
trigger
object
required
outline
string[]
required

Flow steps in plain language.

warnings
object[]
required

Non-blocking warnings, such as a WhatsApp template still under review by Meta.

next_step
string
required
id
string
Pattern: ^flw_[A-Za-z0-9_-]+$
revision
string

Revision of the saved draft. Send it when activating the flow after review.

html_url
string<uri>

Link to the flow in the Bevits editor, for review.