Skip to main content
PATCH
Update a workflow

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

uuid
string
required

Workflow identifier

Body

application/merge-patch+json

The updated Workflow resource

tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

name
string
description
string | null
isActive
boolean
default:false
priority
integer
default:0
canvasData
(string | null)[] | null
triggers
object[]
conditionGroups
object[]
actions
object[]

Response

Workflow resource updated

id
integer
read-only
uuid
string
name
string
description
string | null
isActive
boolean
default:false
priority
integer
default:0
canvasData
(string | null)[] | null
dateCreated
string<date-time>
read-only
dateUpdated
string<date-time>
read-only
createdBy
string<iri-reference> | null
Example:

"/api/v1/users/1"

triggers
object[]
conditionGroups
object[]
actions
object[]