Skip to main content
PUT
Update a Workflow

Authorizations

X-API-Key
string
header
required

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Path Parameters

id
string<uuid>
required

Unique identifier of the workflow.

Body

application/json

Request body containing the updated workflow definition.

name
string
required

Updated workflow name.

Required string length: 1 - 100
Example:

"Payment Notification Flow v2"

description
string

Updated description of the workflow.

Maximum string length: 500
Example:

"Updated flow with additional logging step."

edges
object[]

Updated connections between nodes.

Maximum array length: 200
metadata
object

Updated custom metadata.

nodes
object[]

Updated list of workflow nodes.

Maximum array length: 100

Response

Indicates that the request was successful and the response contains the requested data.

createdAt
string<date-time>

Timestamp when the workflow was created.

Example:

"2026-03-17T14:30:00Z"

description
string

Human-readable description of the workflow.

Example:

"Receives a webhook trigger and logs the payment event."

edges
object[]

Connections between nodes that define the execution flow.

id
string<uuid>

Unique identifier of the workflow.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

metadata
object

Custom key-value pairs for tagging or categorizing.

Example:
name
string

Unique name of the workflow.

Example:

"Payment Notification Flow"

nodes
object[]

The steps that make up this workflow.

status
enum<string>

Current lifecycle status: draft (editable), active (executable), or inactive (archived).

Available options:
draft,
active,
inactive
Example:

"active"

updatedAt
string<date-time>

Timestamp of the last update.

Example:

"2026-03-17T15:00:00Z"