v3

OpenAPI 3.1.02026-07-31350397683.8 KB

Scenario Builder

Update Workflow V2

Update name, description, agent links, and/or definition (React Flow graph).

put/v1/scenario/{workflow_id}

Path parameters

workflow_idstring uuid required

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

namestring nullable

New name for the workflow

agent_idsinteger[] nullable

Set owning agents, or null to clear agent links (must belong to your organization when set).

descriptionstring nullable

New description (set empty string to clear if your client sends it)

definitionobject nullable

Full React Flow definition when replacing the graph. Same shape as create: each node needs a top-level id; each edge needs a top-level id unique among edges.

Response

Successful Response

idstring required

Workflow ID

organization_idstring nullable

Owning organization ID (set by middleware on create)

agent_idsinteger[]

Linked agent ids when the workflow is agent-scoped

namestring required

Name of the workflow

descriptionstring nullable

Description

definitionobject required

Stored React Flow graph (start / single / options nodes). Nodes and edges use top-level string id fields; edge id values are unique within the graph.

created_atstring date-time required

Creation timestamp

dh_sync_summaryobject nullable

Present on PUT responses when the definition was updated. Keys: updated, created, marked_stale, skipped, errors.

warningsstring[]

Non-blocking lint warnings emitted at save time (e.g. node text referencing an unknown {{trait_name}}). Empty when the definition is clean or no agents are linked.