Flows / Update flow

Update flow

PATCH/v1/flows/{id}

Partially update a flow. You can also change status here (draft, published, or archived), though publishing through the publish endpoint runs the same readiness checks.

Path parameters

string · required

The flow id.

Body parameters

name

string

New name.

description

string

New description.

status

string

draft, published, or archived.

trigger_config

object

Replace the trigger.

actions_config

array

Replace the actions.

Response fields

string

Prefixed identifier, e.g. flow_0Dzj….

site_id

string

The site this flow belongs to.

name

string

Up to 255 characters.

status

string

draft (not delivering), published (live), or archived.

trigger_config

object | null

What fires the flow, e.g. { integrationId, pageFilter }.

trigger_name

string | null

Resolved display name of the trigger, e.g. Gravity Forms.

actions_config

array | null

The destinations that receive the conversion.

published_at

timestamp | null

When it was last published. null while in draft.

PATCH/v1/flows/{id}

curl -X PATCH https://app.converly.io/api/v1/flows/flow_0Dzj… \
  -H "Authorization: Bearer sk_live_…" \
  -d '{ "name": "Demo bookings (v2)" }'

200 OK

{
  "id": "flow_0Dzj…",
  "name": "Demo bookings (v2)",
  "status": "published"
}