Skip to main content
PATCH
/
workspaces
/
{workspace_id}
/
workflows
/
{workflow_id}
Error
A valid request URL is required to generate request examples
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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