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

# Pause Workflow

> Pause an active workflow. Leads in progress finish their current step, no new steps start, and the workflow can be resumed later.

<Warning>
  **Legacy endpoint - deprecated.** Unversioned endpoints are scheduled for removal on **July 31, 2026**. Use [Update Workflow Status](/docs/api-reference/v1/workflows/status) with `action: "pause"` for new `/v1` integrations. This endpoint remains available for existing integrations until then.
</Warning>

Pauses an active workflow. Any lead currently in an active step, for example a live voice call or an in-flight webhook delivery, is allowed to complete that step. After that, no new steps are triggered for any lead until the workflow is resumed. Leads that have not started yet remain queued. Use [Resume Workflow](/docs/api-reference/workflows/resume) to return the workflow to `active` state. Time-delay countdowns continue from where they left off, so the pause does not "lengthen" the delay for waiting leads.

## When to use this

Pause is the right call when you want a reversible stop, not a permanent shutdown. Common cases:

* **Carrier or telephony incidents**: pause outbound activity until upstream connectivity recovers, then resume.
* **Holiday or quiet-hours windows**: stop dialling temporarily to honor a known no-call window.
* **Investigation**: pause while you investigate a complaint, prompt change, or data-quality issue, then resume after remediation.
* **Configuration changes**: pause before adjusting concurrency or retry settings, then resume under the new configuration.

If you need to stop the workflow permanently, use [Cancel Workflow](/docs/api-reference/workflows/cancel) instead. Cancellation cannot be reversed.

## Behavior

* In-flight steps are not interrupted.
* New steps stop firing as soon as the pause takes effect.
* Time-delay nodes do not reset their countdowns.
* The workflow's `status` becomes `paused` and remains paused until [Resume Workflow](/docs/api-reference/workflows/resume) is called.

## Path parameters

| Parameter | Description                                      |
| --------- | ------------------------------------------------ |
| `id`      | The workflow ID, for example `wfl_m3v7zb9rk2px`. |

## Errors

* `404 Not Found` is returned when the workflow does not exist.
* `409 Conflict` is returned when the workflow is not currently active (for example it is already paused or cancelled).

## Related endpoints

* [Resume Workflow](/docs/api-reference/workflows/resume): return a paused workflow to `active`.
* [Cancel Workflow](/docs/api-reference/workflows/cancel): permanently stop the workflow.
* [Get Workflow](/docs/api-reference/v1/workflows/get): confirm the new status.


## OpenAPI

````yaml POST /workflows/{id}/pause
openapi: 3.0.0
info:
  title: DialNexa API
  description: >-
    Public REST API for the DialNexa voice AI platform. Versioned endpoints are
    under /v1; unversioned endpoints are legacy and deprecated.
  version: 1.0.0
servers:
  - url: https://api.dialnexa.com
    description: DialNexa production API
security:
  - bearer: []
tags:
  - name: API Keys
  - name: Agent Functions
  - name: Agents V1
  - name: Agents2
  - name: Batch Calls
  - name: Batch Calls V1
  - name: Call Logs
  - name: Calls
  - name: Calls V1
  - name: Campaign Leads
  - name: Campaigns
  - name: External Webhooks
  - name: Knowledge Base
  - name: Knowledge Base V1
  - name: LLMs
  - name: LLMs V1
  - name: Languages
  - name: Languages V1
  - name: Organization Phone Numbers
  - name: Organization Phone Numbers V1
  - name: Phone Number Pricing
  - name: Phone Number Pricing V1
  - name: Transcribers
  - name: Transcribers V1
  - name: User Webhooks
  - name: User Webhooks V1
  - name: V1
  - name: Voices
  - name: Voices V1
  - name: Webcall
  - name: Workflow Leads
  - name: Workflow Leads V1
  - name: Workflows
  - name: Workflows V1
paths:
  /workflows/{id}/pause:
    post:
      tags:
        - Workflows
      summary: Pause a running workflow
      description: >-
        **Legacy endpoint - deprecated, scheduled for removal on July 31,
        2026.** Use the `/v1` version for new integrations. 
      operationId: WorkflowsController_pauseWorkflow
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Workflow paused successfully
        '400':
          description: Bad Request - Invalid workflow status
        '404':
          description: Workflow not found
      deprecated: true
components:
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````