Skip to content

workflow_update

Managementcatalog

Update Workflow

Not in the default tool list

This tool lives in the tool catalog. Discover it with scenario_tools_search (or enumerate everything with scenario_tools_list) and run it via scenario_tool_execute_write. To list every tool directly, connect with ?toolsets=full.

Update an existing workflow's metadata or definition. Supplied fields replace existing values and draft status unpublishes the workflow; confirm overwrites or unpublishing first. Args: - workflow_id: required - name, description: optional metadata - status: "draft" unpublishes the app while preserving its graph and compiled flow; "ready" restores an existing compiled flow without recompiling. Use workflow_publish to compile editor changes. - flow, inputs_definition, editor_info: optional definition fields. Editing editor_info without also supplying flow leaves the compiled flow stale until re-published. The response carries _publishHint in that case unless status="draft" was explicitly requested. - team_id, project_id: required for OAuth callers Returns: the updated workflow record (plus _publishHint when editor_info changed without a fresh flow). Examples: - "Rename this workflow" -> workflow_id="workflow_xxx", name="new-name" - "Unpublish this app" -> workflow_id="workflow_xxx", status="draft"
destructiveopen-world

Parameters

NameTypeRequiredDescription
workflow_idstring✓Workflow ID.
namestring—Workflow name (for create/update).
descriptionstring—Workflow description (for create/update).
statusenum(draft | ready)—Set draft to unpublish without deleting the graph or compiled flow. ready reuses an existing compiled flow; use workflow_publish to compile editor changes.
flowarray—Workflow flow definition (array of node objects).
inputs_definitionarray—Workflow input definitions.
editor_inforecord—UI editor metadata (managed by the Scenario webapp). Validated against the webapp's import schema before persisting.
team_idstring—Team ID. Required with project_id for OAuth callers; an API key is scoped by the key.
project_idstring—Project ID. Required with team_id for OAuth callers; an API key is scoped by the key.
response_formatenum(json | markdown)jsonOutput format: 'json' for structured data, 'markdown' for human-readable text.