Skip to main content
PATCH
Update a workflow

Authorizations

Authorization
string
header
required

User API key: Authorization: Bearer mx_live_*. The X-API-KEY: mx_live_* header is also accepted.

X-Organization-ID
string
header
required

Required organization context for org-scoped endpoints.

Path Parameters

workflow_id
string<uuid>
required

Workflow UUID.

Body

application/json

Partial update — all fields optional; only provided fields are changed.

name
string
description
string
category
string
status
string
visibility
string
tags
string[]
version
string
workflow_schema
object
input
object
config
object

Response

The updated workflow.

A workflow definition and its metadata.

id
string<uuid>
organization_id
string<uuid>
creator_id
string<uuid> | null
name
string
description
string | null
version
string | null
tags
string[]
category
string | null
status
string
Example:

"draft"

visibility
string
Example:

"organization"

workflow_schema
object

Full WorkflowDefinition (nodes, edges, state_schema, metadata).

input
object

Default input parameters.

config
object

Default execution config.

edit_version
integer | null
last_edited_by
string<uuid> | null
last_edited_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>