Update Workflow

Updates a workflow’s name and flow_data. This changes only the draft (the test graph); production keeps running the live version until you deploy a new one. The caller must own the workflow or have write access, and a shared editor cannot save while the workflow is locked. The workflow is validated on save and any issues are returned in the response; the save succeeds even when errors are present. The sharing group’s flattened agent and sub-workflow set is not refreshed by this call; re-share the workflow to pull in any new sub-resources.

PUT /workflows/{id}

Update a workflow

cURL

curl --request PUT \
  --url https://inference.studio.lyzr.ai/api/workflows/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "flow_id": "<string>",
  "flow_name": "Document Processing Flow",
  "flow_data": {
    "name": "Minimal Example",
    "nodes": [
      {
        "id": "a1b2c3d4-0000-0000-0000-000000000001",
        "name": "Trigger",
        "type": "lyzr-nodes-base.trigger",
        "typeVersion": 1,
        "parameters": {},
        "position": [
          240,
          300
        ]
      },
      {
        "id": "a1b2c3d4-0000-0000-0000-000000000002",
        "name": "Set",
        "type": "lyzr-nodes-base.set",
        "typeVersion": 3.4,
        "parameters": {
          "assignments": {
            "assignments": [
              {
                "id": "f1",
                "name": "greeting",
                "type": "string",
                "value": "=Hello {{ $json.name }}"
              }
            ]
          }
        },
        "position": [
          480,
          300
        ]
      }
    ],
    "connections": {
      "Trigger": {
        "main": [
          [
            {
              "node": "Set",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "settings": {}
  },
  "version": 123,
  "is_owner": true,
  "user_id": "<string>",
  "org_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}
'

200

{
  "message": "<string>",
  "issues": [
    {
      "severity": "error",
      "code": "missing_parameter",
      "nodeId": "3",
      "nodeName": "HTTP Request",
      "path": "parameters.url",
      "message": "url is required",
      "hint": "<string>"
    }
  ]
}

Authorizations

x-api-key · string · header · required

Lyzr API key. Studio session keys (agk_, ags_) and durable sk- keys are accepted. Required on every endpoint except GET /node-types and a webhook-triggered execute that carries X-Webhook-Secret.

Path Parameters

id · string · required

Workflow ID

Body

application/json

Workflow definition

flow_id · string

flow_name · string

Example:

"Document Processing Flow"

flow_data · object

Workflow graph definition as JSON (nodes, connections, and node configuration). See the flow_data reference for the full structure and the node types reference for every node type.

Example:

{
  "name": "Minimal Example",
  "nodes": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Trigger",
      "type": "lyzr-nodes-base.trigger",
      "typeVersion": 1,
      "parameters": {},
      "position": [240, 300]
    },
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000002",
      "name": "Set",
      "type": "lyzr-nodes-base.set",
      "typeVersion": 3.4,
      "parameters": {
        "assignments": {
          "assignments": [
            {
              "id": "f1",
              "name": "greeting",
              "type": "string",
              "value": "=Hello {{ $json.name }}"
            }
          ]
        }
      },
      "position": [480, 300]
    }
  ],
  "connections": {
    "Trigger": {
      "main": [
        [
          { "node": "Set", "type": "main", "index": 0 }
        ]
      ]
    }
  },
  "settings": {}
}

version · integer

is_owner · boolean

Computed per response so the UI can distinguish owned rows from shared rows without seeing the owner's key. Not persisted.

user_id · string

org_id · string

created_at · string

updated_at · string

Response

200

application/json

OK

message · string

issues · object[]

Validation issues found when saving. The save succeeds even when errors are present; fix them before you run the workflow.

Show child attributes