Skip to main content
PATCH
/
api
/
v1
/
workflows
/
{workflow_id}
Update Workflow
curl --request PATCH \
  --url https://control-plane.kubiya.ai/api/v1/workflows/{workflow_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "status": "pending",
  "steps": [
    "<any>"
  ],
  "current_step": "<string>",
  "configuration": {},
  "state": {}
}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": "pending",
  "steps": [
    "<any>"
  ],
  "current_step": "<string>",
  "configuration": {},
  "team_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "state": {},
  "error_message": "<string>"
}

Path Parameters

​
workflow_id
string
required

Body

application/json
​
name
string | null
​
description
string | null
​
status
enum<string> | null

Workflow status enumeration

Available options:
pending,
running,
paused,
completed,
failed,
cancelled
​
steps
any[] | null
​
current_step
string | null
​
configuration
object | null
​
state
object | null

Response

Successful Response

​
id
string
required
​
name
string
required
​
description
string | null
required
​
status
enum<string>
required

Workflow status enumeration

Available options:
pending,
running,
paused,
completed,
failed,
cancelled
​
steps
any[]
required
​
current_step
string | null
required
​
configuration
object
required
​
team_id
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required
​
state
object
required
​
error_message
string | null
required