PATCH
/
v1
/
workflows
/
{workflow_id}
Update Workflow
curl --request PATCH \
  --url https://api.cyberdesk.io/v1/workflows/{workflow_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "main_prompt": "<string>",
  "output_schema": "<string>",
  "includes_file_exports": true,
  "is_webhooks_enabled": true
}'
{
  "name": "<string>",
  "main_prompt": "<string>",
  "output_schema": "<string>",
  "includes_file_exports": false,
  "is_webhooks_enabled": false,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "includes_input_variables": false,
  "old_versions": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workflow_id
string<uuid>
required

Body

application/json

Schema for updating a workflow

​
name
string | null
Maximum length: 255
​
main_prompt
string | null
Minimum length: 1
​
output_schema
string | null

JSON schema for output data transformation

​
includes_file_exports
boolean | null

Enable AI-based file export detection

​
is_webhooks_enabled
boolean | null

Send webhook on run completion

Response

Successful Response

Workflow response schema

​
main_prompt
string
required
Minimum length: 1
​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
name
string | null
Maximum length: 255
​
output_schema
string | null

JSON schema for output data transformation

​
includes_file_exports
boolean
default:false

Enable AI-based file export detection

​
is_webhooks_enabled
boolean
default:false

Send webhook on run completion

​
user_id
string<uuid> | null
​
organization_id
string | null
​
includes_input_variables
boolean
default:false
​
old_versions
Old Versions · object[] | null