> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getomni.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Pause Workflow Run

> Pause an active workflow run

Pause a workflow run. The agent stops conducting the workflow: outreach to the lead stops and any queued messages are cancelled. Inbound replies are still answered. The agent cannot be given another workflow run on this lead until this one is resumed, cancelled, or completed.

Pausing a workflow run that is already `PAUSED` succeeds and changes nothing.

## Authentication

Requires the `x-api-key` header with a valid workspace API key.

## Path Parameters

<ParamField path="workflowRunId" type="string" required>
  The workflow run to pause.
</ParamField>

This endpoint takes no body.

## Response

<ResponseField name="success" type="boolean">
  Whether the request succeeded.
</ResponseField>

<ResponseField name="workflowRun" type="object">
  The workflow run in its new state. See
  [Get Workflow Run](/api-reference/workflow-runs/get-workflow-run) for the
  full shape.
</ResponseField>

## Errors

<ResponseField name="404" type="error">
  No workflow run with this id exists in your workspace.
</ResponseField>

<ResponseField name="409" type="error">
  The workflow run is already `COMPLETED` or `CANCELLED`. Terminal workflow runs cannot change
  status.
</ResponseField>

<RequestExample>
  ```javascript Node.js theme={null}
  const options = {
    method: "POST",
    headers: { "x-api-key": "<your-api-key>" },
  };

  fetch(
    "https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/pause",
    options,
  )
    .then((response) => response.json())
    .then((response) => console.log(response))
    .catch((err) => console.error(err));
  ```

  ```python Python theme={null}
  import requests

  url = "https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/pause"
  headers = {"x-api-key": "<your-api-key>"}

  response = requests.request("POST", url, headers=headers)
  print(response.json())
  ```

  ```bash cURL theme={null}
  curl --request POST \
    --url https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/pause \
    --header 'x-api-key: <your-api-key>'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "workflowRun": {
      "id": "5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
      "leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
      "agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "PAUSED",
      "createdAt": "2026-09-10T17:42:03.000Z",
      "completedAt": null,
      "cancelledAt": null
    }
  }
  ```
</ResponseExample>