Update Workflow

Update an existing workflow by entity ID. The request body must be the full workflow graph — the server replaces the entire stored graph, so partial field updates are not supported.

The checksum from the last Get workflow by id, Create, or Update response is required. If it does not match the server's current checksum, the update is rejected.

On success, the response returns a new data.checksum — store it before calling test or publish.

Update workflow

patch

Update an existing workflow by entity ID.

Send the full workflow graph — the server replaces the entire stored graph. Partial field updates are not supported.

Recommended flow:

1. GET /dev/v1/workflow/{entity-id} → copy data and data.checksum

2. Modify the fields you need

3. PATCH with the full modified document + checksum from step 1

checksum is required. If it does not match the server's current checksum the update is rejected.

On success: response returns a new data.checksum — store it before calling test or publish.

Canonical request body: Update/update_workflow.json

Authorizations

DevAuth

Nected-API-KeystringRequired

Your Nected API key. Obtain from your workspace settings.

Path parameters

entity-idstringRequired

The workflow entity ID

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Header parameters

Nected-BranchstringOptional

Branch name (optional)

Body

application/json

Request body for Update workflow. Send the full workflow graph (same shape as Create) plus checksum.

Do not send partial field updates — the server replaces the full graph. Recommended: get the current document, modify it, send it back with the current checksum.

Canonical file: Update/update_workflow.json.

checksumstringOptional

Current checksum from the last get/create/update — required for optimistic locking

namestringOptional

descriptionstringOptional

startNodestringOptional

triggerobjectOptional

commentstringOptional

isEnabledbooleanOptional

Other propertiesanyOptional

Responses

200

OK — returns new data.checksum.

application/json

Success response for PATCH /dev/v1/workflow/{entity-id}

codestringOptional

messagestringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

patch

/dev/v1/workflow/{entity-id}

HTTPcURLJavaScriptPython

PATCH /dev/v1/workflow/{entity-id} HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 4202

{
  "checksum": "7f3d2a1b9c8e4f6a0d5b2c7e1a9f3d8c",
  "name": "Order_Discount_Workflow_v2",
  "description": "Updated: Calculates discount — now includes platinum tier at 20%.",
  "startNode": "node_abc123codenode01",
  "isEnabled": true,
  "comment": "",
  "settings": {
    "auditIO": true,
    "dateFormat": "in",
    "timezone": "Asia/Kolkata"
  },
  "trigger": {
    "apiNode": "1"
  },
  "dependencyMap": [],
  "nodes": [
    {
      "id": "1",
      "type": "trigger",
      "position": {
        "x": 687.5,
        "y": 0
      },
      "style": null,
      "sourcePosition": "bottom",
      "targetPosition": "top",
      "draggable": false,
      "data": {
        "nodeType": "apiTrigger",
        "name": "Trigger",
        "entity": "",
        "entityId": "",
        "pluginName": "",
        "status": "",
        "rootId": "",
        "sourceIds": null,
        "isMergeNode": false,
        "switcher": null,
        "conditions": null,
        "blockName": "",
        "input": {
          "orderId": {
            "name": "orderId",
            "dataType": "string",
            "executedValue": "ORD-20260101-9921",
            "isCaseSensitive": false,
            "isNullable": false,
            "isOptional": false,
            "keyAttribute": "",
            "keySource": "",
            "mapping": false,
            "notSend": false,
            "order": 0,
            "schemaId": "",
            "sendNull": false,
            "source": "",
            "attribute": "",
            "value": null
          },
          "cartTotal": {
            "name": "cartTotal",
            "dataType": "numeric",
            "executedValue": 1250,
            "isCaseSensitive": false,
            "isNullable": false,
            "isOptional": false,
            "keyAttribute": "",
            "keySource": "",
            "mapping": false,
            "notSend": false,
            "order": 1,
            "schemaId": "",
            "sendNull": false,
            "source": "",
            "attribute": "",
            "value": null
          },
          "customerTier": {
            "name": "customerTier",
            "dataType": "string",
            "executedValue": "platinum",
            "isCaseSensitive": false,
            "isNullable": false,
            "isOptional": false,
            "keyAttribute": "",
            "keySource": "",
            "mapping": false,
            "notSend": false,
            "order": 2,
            "schemaId": "",
            "sendNull": false,
            "source": "",
            "attribute": "",
            "value": null
          }
        },
        "output": null,
        "settings": {
          "authType": "none",
          "isEnabled": true
        },
        "executedValue": {
          "orderId": "ORD-20260101-9921",
          "cartTotal": 1250,
          "customerTier": "platinum"
        },
        "runInLoop": {
          "status": false,
          "source": "",
          "attribute": "",
          "value": null
        }
      }
    },
    {
      "id": "node_abc123codenode01",
      "type": "codeNode",
      "position": {
        "x": 687.5,
        "y": 205
      },
      "style": null,
      "sourcePosition": "bottom",
      "targetPosition": "top",
      "draggable": false,
      "data": {
        "nodeType": "codeNode",
        "name": "Calculate_Discount",
        "entity": "codeNode",
        "entityId": "node_abc123codenode01",
        "pluginName": "",
        "status": "success",
        "rootId": "",
        "sourceIds": null,
        "isMergeNode": false,
        "switcher": null,
        "conditions": null,
        "blockName": "",
        "input": {
          "language": {
            "name": "",
            "dataType": "",
            "executedValue": null,
            "isCaseSensitive": false,
            "isNullable": false,
            "isOptional": false,
            "keyAttribute": "",
            "keySource": "",
            "mapping": false,
            "notSend": false,
            "order": 0,
            "schemaId": "",
            "sendNull": false,
            "source": "",
            "attribute": "",
            "value": "excelFormula"
          },
          "snippet": {
            "name": "",
            "dataType": "",
            "executedValue": null,
            "isCaseSensitive": false,
            "isNullable": false,
            "isOptional": false,
            "keyAttribute": "",
            "keySource": "",
            "mapping": false,
            "notSend": false,
            "order": 1,
            "schemaId": "",
            "sendNull": false,
            "source": "",
            "attribute": "",
            "value": "let cartTotal = {{.Trigger.cartTotal}};\nlet tier = {{.Trigger.customerTier}};\nlet discountPct = 0;\nif (tier === 'platinum') { discountPct = 20; }\nelse if (tier === 'gold') { discountPct = 15; }\nelse if (tier === 'silver') { discountPct = 10; }\nelse { discountPct = 5; }\nlet discountAmount = cartTotal * discountPct / 100;\nlet finalAmount = cartTotal - discountAmount;\n{ discountPct, discountAmount, finalAmount };"
          }
        },
        "output": null,
        "settings": {
          "errorContinue": false,
          "timeout": 10,
          "timeoutAsync": 20
        },
        "executedValue": {
          "error": "",
          "executionTime": "1ms",
          "output": {
            "discountPct": 20,
            "discountAmount": 250,
            "finalAmount": 1000
          }
        },
        "runInLoop": {
          "status": false,
          "source": "",
          "attribute": "",
          "value": null
        }
      }
    }
  ],
  "edges": [
    {
      "id": "edge_trigger_to_add1",
      "source": "1",
      "target": "node_abc123addnode01",
      "type": "smoothEdge",
      "animated": false,
      "label": "",
      "markerEnd": "",
      "sourceHandle": "",
      "style": {
        "stroke": "gray",
        "strokeWidth": 1
      },
      "data": {
        "edgeType": "then",
        "pathId": ""
      }
    },
    {
      "id": "edge_add1_to_code",
      "source": "node_abc123addnode01",
      "target": "node_abc123codenode01",
      "type": "smoothEdge",
      "animated": false,
      "label": "",
      "markerEnd": "",
      "sourceHandle": "",
      "style": {
        "stroke": "gray",
        "strokeWidth": 1
      },
      "data": {
        "edgeType": "then",
        "pathId": ""
      }
    },
    {
      "id": "edge_code_to_add2",
      "source": "node_abc123codenode01",
      "target": "node_abc123addnode02",
      "type": "smoothEdge",
      "animated": false,
      "label": "",
      "markerEnd": "",
      "sourceHandle": "",
      "style": {
        "stroke": "gray",
        "strokeWidth": 1
      },
      "data": {
        "edgeType": "then",
        "pathId": ""
      }
    }
  ]
}

{
  "data": {
    "checksum": "4e8b1f2a9d3c7e0b5a6f2d9c1e4b8a3f"
  },
  "code": "success",
  "message": "Workflow Updated Successfully."
}

Request body

8KB

update_workflow.json

Open