---
title: "Run a workflow"
method: POST
path: "/workflows/{workflow_id}/run"
tags: ["Workflows"]
---

# Run a workflow

`POST /workflows/{workflow_id}/run`

Run a specified workflow. In the request body, you can include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow, you need to define the parameters first.

**Note**: To run a workflow, do not use the following reserved words in the request body of the parameters.
 - `controller`
 - `action`
 - `id`
 - `user_email`
 - `user_token`
 - `format`

### User Access Permission
You must be assigned the **Workflow Run Access** permission to run this operation.

To learn about how to define parameters, see [Configure the settings of a workflow](https://docs.zuora.com?resourceId=platform-manage-access-permissions-workflow).

## Path parameters

- `workflow_id` integer, required

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Request body

- object

## Response `200`

OK

- WorkflowInstance — A instance workflow object.
  - `createdAt` string, datetime — The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.
  - `id` integer — The unique ID of the workflow.
  - `name` string — The run number of this workflow instance
  - `originalWorkflowId` integer — The identifier of the workflow template that is used to create this instance.
  - `status` 'Queued' | 'Processing' — Describes the current state of this workflow instance: - Queued: The workflow is in queue for being processed. - Processing: The workflow is in process.
  - `updatedAt` string, datetime — The date and time the last time when the workflow is updated, in the `YYYY-MM-DD HH:MM:SS` format.

## Other responses

- `400` — Callout not enabled for the workflow
- `406` — The provided body is missing one or more required parameters
- `409` — The provided workflow_id references a workflow instance

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)