Deactivate a Workflow

Use this endpoint to deactivate a workflow. Transitions the status from active to inactive.

POST /v1/workflows/{id}/deactivate

Deactivate a Workflow

cURL

curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/workflows/{id}/deactivate \
  --header 'X-API-Key: <api-key>'

200

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Payment Notification Flow",
  "description": "Receives a webhook trigger and logs the payment event.",
  "status": "active",
  "nodes": [
    {
      "id": "trigger-1",
      "type": "trigger",
      "name": "Webhook Trigger",
      "position": {
        "x": 0,
        "y": 0
      },
      "data": {
        "triggerId": "webhook"
      }
    },
    {
      "id": "log-event",
      "type": "action",
      "name": "Log Payment Event",
      "position": {
        "x": 200,
        "y": 0
      },
      "data": {
        "action": "log"
      }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "trigger-1",
      "target": "log-event"
    }
  ],
  "metadata": {
    "team": "payments",
    "environment": "sandbox"
  },
  "createdAt": "2026-03-17T14:30:00Z",
  "updatedAt": "2026-03-17T14:31:00Z"
}

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.

Response

200

application/json

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.

Show child attributes

id · string<uuid>

Unique identifier of the workflow.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

metadata · object

Custom key-value pairs for tagging or categorizing.

Show child attributes

Example:

{
  "team": "payments",
  "environment": "sandbox"
}

name · string

Unique name of the workflow.

Example:

"Payment Notification Flow"

nodes · object[]

The steps that make up this workflow.

Show child attributes

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"