Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

idempotency-key
string

Idempotency-Key: 1-255 printable ASCII characters. Same key with a different request body is a 422 idempotency_key_reused. A retryable in-flight duplicate is a 409 with Retry-After and x-should-retry: true; a terminal duplicate is a 409 with x-should-retry: false. A replay returns the current resource state with Idempotent-Replayed: true.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$
Example:

"b3f6a9f0-6f1a-4e9a-9e7a-9c9b6b6a5a3f"

Path Parameters

flowId
string<uuid>
required

Body

application/json
actionId
string<uuid>
required
position
integer
required
Required range: x >= 0
children
object[]
continueOnError
boolean
default:false
key
string

Stable identifier used by template resolution v2+ to address this step as {{key.field}}. Omitted keys are derived from the step name whenever a flow is created. For template resolution v3, replacing an existing flow's full action tree requires every step to carry an explicit key — a missing key is rejected there, not derived, so a name change can never silently move a step's key.

Pattern: ^[a-z_][a-z0-9_-]{0,63}$
nameOverride
string
Required string length: 1 - 256
overrides
object | null
parentFlowActionId
string<uuid> | null
recordingEnabled
boolean
default:false

Response

Flow action added

data
object
required