Skip to main content
PATCH
Error

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

workspace_id
string<uuid>
required
workflow_id
required
Pattern: wf_[0-9a-zA-Z]+

Body

application/json
title
string | null

Workflow title, between 3 and 100 characters

Required string length: 3 - 100
description
string | null

Optional workflow description, up to 1000 characters

Maximum string length: 1000
status
enum<string> | null
Available options:
online,
offline
version
integer | null
entrypoint
string | null
icon_url
string | null
expects
Expects · object | null
returns
unknown
config
DSLConfig · object | null

This is the runtime configuration for the workflow.

Activities don't need access to this.

alias
string | null
error_handler
string | null

Response

Successful Response

id
string
required
Pattern: wf_[0-9a-zA-Z]+
title
string
required
description
string
required
status
string
required
actions
Actions · object
required
workspace_id
string<uuid>
required
webhook
WebhookRead · object
required
schedules
ScheduleRead · object[]
required
entrypoint
string | null
required
returns
any
required
config
DSLConfig · object | null
required

This is the runtime configuration for the workflow.

Activities don't need access to this.

version
integer | null
expects
Expects · object | null
expects_schema
Expects Schema · object | null
alias
string | null
git_sync_branch
string | null
error_handler
string | null
folder_id
string<uuid> | null
trigger_position_x
number
default:0
trigger_position_y
number
default:0
graph_version
integer
default:1