v1

latestOpenAPI 3.1.02026-07-22115189303.8 KB
Workflows

Update workflow

Update workflow metadata or replace workflow definition collections.

Common updates:

  • Change workflow name or description
  • Update workflow definition nodes and edges
  • Activate workflow by setting status to 'active'
  • Archive workflow by setting status to 'archived'

Definition update semantics:

  • Omit definition to update metadata only.
  • Omit definition.nodes to leave nodes unchanged.
  • Include definition.nodes only when sending the complete desired node set. Nodes omitted from that array are removed.
  • Omit definition.edges to leave edges unchanged.
  • Include definition.edges only when sending the complete desired edge set. Edges omitted from that array are removed.
  • Use snake_case config keys in API payloads.

Successful responses contain workflow metadata, including the new lock_version. They do not include the expanded graph. Call GET /workflows/{workflow_id}/definition after updating when you need the saved nodes and edges.

You can update the definition of an active workflow. Changes take effect immediately for new executions; running executions continue with the snapshot they started with.

patch/workflows/{workflow_id}

Request body

Response

Workflow updated successfully

Example response

{
  "data": {
    "slug": "inbound-support"
  }
}