Skip to main content
POST
Update Workflow

Headers

x-api-key
string | null

Query Parameters

workflow_id
string
required

Body

application/json
workflow_name
string | null

New workflow name.

workflow_description
string | null

New workflow description.

workflow_definition
WorkflowGraph · object | null

Replacement workflow graph.

starred
boolean | null

Whether the workflow is starred.

locked
boolean | null

Whether the workflow is locked.

Response

Successful Response

id
string
required

Workflow identifier.

name
string
required

Workflow name.

status
string
required

Lifecycle status of the workflow definition (e.g. draft, ready).

step
string
required

Current authoring step in the builder UI.

created_at
string<date-time>
required

Timestamp when the record was created.

updated_at
string<date-time>
required

Timestamp when the record was last updated.

user_uuid
string | null

User who created the workflow.

org_id
string | null

Organization that owns the workflow.

description
string | null

Workflow description.

display_status
WorkflowDisplayStatus · object | null

Resolved label and tone for status + step, so clients render rather than interpret them.

last_run_date
string<date-time> | null

Timestamp of the most recent run.

team_id
string | null

Team that owns the workflow; null for org-pool workflows.

starred
boolean | null

Whether the caller's organization has starred the workflow.

locked
boolean | null

Whether the graph is locked against edits.

block_count
integer | null

Number of blocks in the workflow. Present on list responses, where the graph itself is omitted, so a caller can tell an empty workflow from a populated one without fetching every definition.

workflow_definition
WorkflowGraph · object

A workflow expressed as a directed graph of blocks and edges.