Skip to main content
POST
Activate flow

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.

Path Parameters

flow_id
string
required

Public flow ID.

Pattern: ^flw_[A-Za-z0-9_-]+$

Body

application/json
revision
string
required

The revision the person reviewed, returned when creating the draft or getting the flow.

Pattern: ^rev_[0-9a-f]+$

Response

Flow found.

object
string
required
Allowed value: "flow"
id
string
required
Pattern: ^flw_[A-Za-z0-9_-]+$
status
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
html_url
string<uri>
required
name
string
description
string
trigger_event_type
string
origin
string
run_count
integer
deprecated

Deprecated legacy field retained for compatibility. When present, always returns 0; it does not represent the actual execution count.

Required range: x >= 0
revision
string

Identifies the flow's current content (blocks and connections). Send it when activating the flow so only the reviewed content goes live.