Skip to main content
PATCH
Change part of a workflow (merge)

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id
string
required
workflow_id
string
required

Body

application/json

Identical to the create body and validated by the same validateWorkflowSpec — this is a FULL REPLACE, not a merge: every omitted field reverts to its default (e.g. omitting active re-activates, omitting entry_conditions clears them). PATCH is accepted on this path and behaves identically. version is incremented server-side; it cannot be set.

name
string
Required string length: 1 - 120
slug
string
active
boolean
default:true
entry_dataset
string
Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,62}$
entry_conditions
object[]
steps
object[]

Same nine step types and same limits as createWorkflow (<= 32 steps including branch sub-steps; branch depth <= 3; no delay/wait_for_event inside a branch; delay and wait timeout <= 365 days; steps <= 262144 bytes serialized).

Minimum array length: 1

Response

Replaced; version incremented.

ok
enum<boolean>
required
Available options:
true