Skip to main content

Update Workflow

PUT 
/api/automation/workflows/:workflow

Update a workflow's name, description, category, graph, or settings. When nodes are submitted, the trigger type and trigger configuration are re-derived from the graph.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Body fields (all optional): name (string, max 128), description, category (string, max 50), nodes (array - each node requires id (string, max 64), type (string, max 100), position.x/position.y (numeric), data (object, required per node), optional label), edges (array - each edge requires id, source, target; optional sourceHandle, targetHandle, label, branchLabel), viewport, settings, preview_mode (boolean).

Path param: workflow = workflow id.

Preview mode: preview_mode (optional, boolean, default false). While a workflow is in preview mode every run — triggered, manual, or replayed — executes triggers, conditions, and lookups for real but skips every step that would change something (all Action and Integration nodes: emails, Slack messages, webhooks, spreadsheet writes, order updates). Skipped steps are recorded in the execution with the input they would have used, so a preview run reads exactly like a real one. Read-only actions are exempt and still run.

Request​

Responses​

OK

Response Headers
    Content-Type