Skip to main content
PATCH
Update workflow status

Authorizations

x-api-key
string
header
required

Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:

Headers

x-username
string
default:(project default user)

External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.

Path Parameters

id
string
required

Workflow (agent) ID

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Body

application/json
activeStatus
boolean
required

True to activate the workflow (requires lifecycle=ready), false to deactivate it.

Example:

true

Response

200 - application/json

Workflow status updated successfully

success
boolean
required

Success status

Example:

true

message
string
required

Success message

Example:

"Operation completed successfully"

data
object
required
Example: