update_workflow
Edit an existing workflow. Only the fields you pass are changed. Run with preview: true first to validate without persisting, then call again with preview: false to apply.
Passing node_config / edge_config / node_credentials replaces the whole value for that field — send complete arrays/maps, not deltas. The usual flow is get_workflow → modify the returned arrays → update_workflow.
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_id | string | yes | Workflow id (agent_…) | |
name | string | no | New name | |
description | string | no | New description | |
task_description | string | no | New task description | |
node_config | array | string | no | Full JSON array of node objects (replaces existing) | |
edge_config | array | string | no | Full JSON array of edge objects (replaces existing) | |
node_credentials | object | no | Full {node_id: account_id} map (replaces existing) | |
usecase | string | no | New usecase key | |
preview | boolean | no | false | If true, apply + validate inside a rolled-back transaction and return validation results without persisting |
Returns#
json
{ "id": "agent_abc", "name": "Enrich Contact v2", "valid": true, "validation_errors": [], "url": "https://app.adlyse.com/workflows/agent_abc" }Preview responses additionally carry "preview": true.
Errors#
error_type | When |
|---|---|
auth_error | Missing / invalid API key |
not_found | Workflow id doesn’t exist or is outside your org |
validation_error | Malformed graph JSON or graph fails authoring validation |
See also#
get_workflow— read the current graph before editingcreate_release— freeze the edited draft once it validates