PATCH
/
workflows
/
{workflow_id}
curl -X PATCH \
  -H 'Authorization: Bearer $API_KEY' \
  -H 'x-api-key: $API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"name": "Updated Workflow #4", "team_id": "41480ee5-14ff-4f9e-89bf-91b0a8e50e77", "owner_id": "ab7dafe2-4f19-4570-bad0-a88e70ad2c11", "is_external": false, "canvas_type": 0}' \
  '$BASE_URL/workflows/$workflow_id'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Updated Workflow #4",
  "team_id": "41480ee5-14ff-4f9e-89bf-91b0a8e50e77",
  "owner_id": "ab7dafe2-4f19-4570-bad0-a88e70ad2c11",
  "canvas_type": 0,
  "is_external": false
}

Headers

​
x-api-key
string
required

Your API key. This is required by most endpoints to access the API programmatically. You can view your x-api-key using the 'Profile' tab on the website.

​
Authorization
string
required

Bearer token for authentication (JWT).

Path Parameters

​
workflow_id
string
required

The UUID of the workflow to update.

Body

application/json
JSON fields to update on the specified workflow.
​
name
string

New workflow name.

​
team_id
string

UUID of the team to which the workflow will be reassigned.

​
owner_id
string

UUID of the new owner of this workflow (if your code allows updating ownership).

​
is_external
boolean

Whether this workflow is marked as external.

​
canvas_type
integer

Canvas type (0 for basic, etc.).

Response

200
application/json
Successfully updated workflow. Returns the updated workflow JSON.
​
id
string

The workflow’s UUID.

​
name
string

Updated workflow name.

​
team_id
string

Current team UUID after update.

​
owner_id
string

Current owner UUID after update (if changed).

Get Workflows by IDCancel Workflow Run