Skip to content

workflow_definition_update

Edit a workflow draft.

Tool

workflow_definition_update

Edit a workflow draft.

Edit a workflow draft. Published versions are immutable — this only ever writes version 0. The definition's `id`, `product_id`, `name`, `description`, `status`, `version` and `dependencies` are server-owned: send them or not, they are overwritten. `grants`, `config_refs` and `owner` are yours.

Behavior

HTTP
POST /workflow/definition/update

Arguments

Name
Type
Required
Description
name
string
—
No description in the catalog.
definition
object
—
A workflow definition: trigger, nodes, edges, grants, config_refs.
description
string
—
No description in the catalog.
workflow_id
string
•
No description in the catalog.

Response

Field
Type
Always
Description
live
object
•
draft
object
•
grants
object
•
The workflow principal's grants; null when Governance could not be reached.
health
object
•
What the dependency check found; null when nothing is unknown.
issues
array
•
Validation of the draft as it stands right now.
timeline
array
•
The last 20 health entries, newest first; `workflow_health_list` pages the rest.
workflow
object
•
dependencies
array
•
What the live version was validated against, with the hashes it saw.

Try it

Edit a workflow draft.

When to use

Edit a workflow draft. Published versions are immutable — this only ever writes version 0. The definition's `id`, `product_id`, `name`, `description`, `status`, `version` and `dependencies` are server-owned: send them or not, they are overwritten. `grants`, `config_refs` and `owner` are yours.

Example

Ask your agent something like this:

Edit a workflow draft.

The agent will invoke workflow_definition_update with these arguments:

{
  "workflow_id": "<workflow_id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select