---
title: "Run a workflow"
method: PUT
path: "/v4/workflows/{workflowId}/run"
tags: ["Workflows"]
---

# Run a workflow

`PUT /v4/workflows/{workflowId}/run`

## Request

- Base URL: `https://api.kadoa.com`
- URL: `https://api.kadoa.com/v4/workflows/{workflowId}/run`
- Auth: API key in header `x-api-key`

## Path parameters

- `workflowId` string, required

## Request body

- object
  - `variables` object: Optional variables to pass to the workflow execution
  - `limit` number: Optional limit for the number of records to process
  - `preview` boolean: Rerun the preview of a PREVIEW-state workflow instead of starting a production run

## Response `200`

Workflow started successfully

- object
  - `message` string
  - `jobId` string: The ID of the created job
  - `status` string: The status of the job

## Other responses

- `400`: Bad request (workflow not found, already running, etc.)
- `401`: x-api-key missing or not authorized
- `409`: Workflow lifecycle conflict. Pass preview=true to rerun a stale preview instead.
- `429`: Too many concurrent jobs
- `500`: Internal service error

---

[API](https://skmtc.dev/kadoa/apis/kadoa-api.md) · [All operations](https://skmtc.dev/kadoa/apis/kadoa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kadoa/apis/kadoa-api/revisions/bf7803c927b4?raw)