Skip to main content
PATCH
/
workflows
/
{workflow_id}
Update Workflow
curl --request PATCH \
  --url https://api.example.com/workflows/{workflow_id} \
  --header 'Content-Type: application/json' \
  --cookie fastapiusersauth= \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "status": "online",
  "object": {},
  "version": 123,
  "entrypoint": "<string>",
  "icon_url": "<string>",
  "static_inputs": {},
  "expects": {},
  "returns": "<unknown>",
  "config": {
    "scheduler": "dynamic",
    "environment": "default",
    "timeout": 300
  },
  "alias": "<string>",
  "error_handler": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

workflow_id
required

Query Parameters

workspace_id
string<uuid>
required

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
object
Object · object
version
integer | null
entrypoint
string | null
icon_url
string | null
static_inputs
Static Inputs · object
expects
Expects · object
returns
unknown
config
DSLConfig · object

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