Skip to main content
PATCH
Update a step

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

flowId
string<uuid>
required

Flow ID.

stepId
string
required

Step ID.

Body

application/json
step
object
required

Partial step — only the fields to change.

Response

Step updated.

flow_id
string<uuid>
required

Flow ID.

type
string
required

Always triggered_flow.

name
string
required

Flow name.

status
enum<string>
required

Lifecycle state. Structure is editable only while draft or paused.

Available options:
draft,
active,
paused,
archived
description
string | null

Description.

triggers
object[]

Entry triggers.

A flow entry trigger. A flow may define up to 25 triggers. Triggers fire on new events only — activating a flow never retroactively enrolls contacts.

steps
object[]

Step graph.

A flow step. A flow may contain up to 100 steps. Steps link via next_step_id (or the branch fields on condition_check); omitting a link ends the flow.

disqualification_rules
object

Contacts matching these rules are dropped (evaluated continuously). null when unset.

reentry_policy
enum<string>

Whether contacts may re-enter after exiting.

Available options:
allow,
no_reentry
manual_membership_enabled
boolean

Whether contacts can be added via the API.

settings
object

Free-form flow settings (max 16 KB).

details
object

Aggregate membership counters.

archived_at
string<date-time> | null

When the flow was archived.

created_at
string<date-time>

Creation time.

updated_at
string<date-time>

Last update.