Deactivate a Workflow

Use this endpoint to deactivate a workflow. Transitions the status from active to inactive. Its waiting executions fail with execution terminated: workflow deactivated; running executions finish. Only a person writes a protected provider configuration, or a workflow that uses a protected or deleted one: an application gets 403 FLK-0365. Create and update accept only protected provider configurations on it (422 FLK-0367), and activation needs a non-empty allowedCallers list (422 FLK-0366).

POST /v1/workflows/{id}/deactivate

Deactivate a Workflow

cURL

curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/workflows/{id}/deactivate \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Payment Notification Flow",
  "description": "Receives a webhook trigger and sets the payment output.",
  "status": "active",
  "nodes": [
    {
      "id": "trigger-1",
      "type": "trigger",
      "name": "Webhook Trigger",
      "position": {
        "x": 0,
        "y": 0
      },
      "data": {
        "triggerType": "webhook",
        "path": "payments/received",
        "method": "POST",
        "input_contract": "open",
        "format": "json"
      }
    },
    {
      "id": "set-output",
      "type": "action",
      "name": "Set Payment Output",
      "position": {
        "x": 200,
        "y": 0
      },
      "data": {
        "actionType": "set_output",
        "output": {
          "status": "received"
        }
      }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "trigger-1",
      "target": "set-output"
    }
  ],
  "metadata": {
    "team": "payments",
    "environment": "sandbox"
  },
  "createdAt": "2026-03-17T14:30:00Z",
  "updatedAt": "2026-03-17T14:31:00Z"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider. Send it in the Authorization header as Bearer <token>.

Parámetros de ruta

id · string<uuid> · requerido

Unique identifier of the workflow.

Respuesta

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.

Ejemplo:

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

description · string

Human-readable description of the workflow.

Ejemplo:

"Receives a webhook trigger and sets the payment output."

edges · object[]

Connections between nodes that define the execution flow.

Show child attributes

id · string<uuid>

Unique identifier of the workflow.

Ejemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

metadata · object

Custom key-value pairs for tagging or categorizing.

Show child attributes

Ejemplo:

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

name · string

Unique name of the workflow.

Ejemplo:

"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).

Opciones disponibles: draft, active, inactive

Ejemplo:

"active"

updatedAt · string<date-time>

Timestamp of the last update.

Ejemplo:

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

allowedCallers · object[] | null

Who may run the workflow: applications by client ID and people by user ID. An empty list lets any caller that the route authorizes run it. Only a person writes this list. A caller outside the list gets 403 FLK-0519 when requesting a new execution, and no execution is created. A schedule or Streaming Hub trigger carries no caller, so it never runs a workflow that has a list.

Show child attributes