> ## 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.

# Update Batch Call Status

> Pause, resume, or cancel a v1 batch call.

Changes state - verify before retry
Update Batch Call Status changes the execution state of a batch call. Use it when you need to temporarily stop new outbound calls, continue a paused batch, or permanently cancel queued work. A batch can be paused while it is `running` or `waiting`, resumed while it is `paused`, and cancelled from any state except `completed` or `cancelled`, including while it is `running`.

## When To Use Update Batch Call Status

* Use `pause` when a `running` or `waiting` batch should stop creating new calls, but calls already in progress can finish.
* Use `resume` when a paused batch should continue calling remaining leads.
* Use `cancel` when a batch should stop permanently and queued calls should be removed. It works from any state except `completed` or `cancelled`; a running batch does not need to be paused first.

## Status Actions

| Action | Result |
| - | - |
| `pause` | Stops new outbound calls, moves the batch to `paused`, and keeps the batch resumable. |
| `resume` | Re-enqueues remaining leads for a paused batch. The campaign can return to `running` or `waiting` depending on whether it has started before and how close the scheduled start time is. |
| `cancel` | Removes queued calls and prevents the batch from resuming. Works from any state except `completed` or `cancelled`, including `running`. |

## Verify The Result

The current API-key success response is an empty object. After HTTP `200`, use [List Batch Calls](https://dialnexa.com/docs/api-reference/v1/batches/list.md) to check the batch status and [List Calls](https://dialnexa.com/docs/api-reference/v1/calls/list.md) with `batch_call_id` to inspect dispatch activity. If the listed batch is `waiting`, it is accepted and awaiting scheduler preparation. Other batches can run concurrently. See [Batch Call Retries And Statuses](https://dialnexa.com/docs/batch-calls/retries-and-statuses.md#batch-lifecycle-state-machine) for the full status diagram.

## Common Errors

* `400 Bad Request` means the action is invalid or the current batch status does not allow that transition.
* `404 Not Found` means the batch call ID was not found in this workspace. A batch that belongs to another workspace is reported the same way.

## Related Endpoints

* [Create Batch Call](https://dialnexa.com/docs/api-reference/v1/batches/create.md): upload leads and create a batch.
* [List Batch Calls](https://dialnexa.com/docs/api-reference/v1/batches/list.md): find batch IDs in your workspace.
* [Get Batch Call](https://dialnexa.com/docs/api-reference/v1/batches/get.md): inspect calls generated by a batch.


## OpenAPI

````yaml PATCH /v1/batch-calls/{id}/status
openapi: 3.0.0
info:
  title: DialNexa API
  description: Public `/v1` REST API for the DialNexa voice AI platform.
  version: 1.0.0
servers:
  - url: https://api.dialnexa.com
    description: DialNexa production API
security:
  - bearer: []
tags:
  - name: Agents
  - name: Batch Calls
  - name: Calls
  - name: Knowledge Base
  - name: Languages
  - name: LLMs
  - name: Phone Numbers
  - name: Organization Folders
  - name: Transcribers
  - name: Webhooks
  - name: Voices
  - name: Workflows
  - name: Workflow Leads
  - name: Authentication
  - name: Agent Builder
  - name: Agent Evaluations
paths:
  /v1/batch-calls/{id}/status:
    patch:
      tags:
        - Batch Calls
      summary: Update Batch Call Status
      description: >-
        Changes the execution status of a batch call. Use `pause` to halt new
        outbound calls, `resume` to continue a paused batch, or `cancel` to
        permanently stop the batch and remove queued calls.
      operationId: updateBatchCallStatus
      parameters:
        - name: id
          required: true
          in: path
          description: Batch call ID
          schema:
            type: string
            example: batch_abc123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBatchCallStatusRequest'
            examples:
              pause:
                summary: Pause a batch call
                value:
                  action: pause
              resume:
                summary: Resume a batch call
                value:
                  action: resume
              cancel:
                summary: Cancel a batch call
                value:
                  action: cancel
      responses:
        '200':
          description: Batch call status updated successfully.
          content:
            application/json:
              examples:
                success:
                  summary: Successful response
                  value: {}
              schema:
                type: object
                properties: {}
        '400':
          description: >-
            Invalid action, or action not allowed for the current batch call
            status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredErrorResponse'
              examples:
                error:
                  summary: 400 Bad Request
                  value:
                    message: >-
                      Request validation failed: action must be one of the
                      following values: pause, resume, cancel
                notAllowed:
                  summary: Action not allowed for the batch status
                  value:
                    message: >-
                      Request validation failed: Campaign status 'paused' is not
                      allowed. Required status: running or waiting
                finalState:
                  summary: Batch already finished
                  value:
                    message: >-
                      Request validation failed: Campaign status 'completed' is
                      not allowed. Campaign is already in a final state.
        '401':
          description: Unauthorized - missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredErrorResponse'
              examples:
                error:
                  summary: 401 Unauthorized
                  value:
                    message: >-
                      API key is missing or invalid. You can generate this by
                      logging in into dashboard
        '404':
          description: Batch call not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredErrorResponse'
              examples:
                error:
                  summary: 404 Not Found
                  value:
                    message: Campaign with ID 2g7Xy3tY53gRlp not found
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredErrorResponse'
              examples:
                error:
                  summary: 500 Internal Server Error
                  value:
                    message: An unexpected error occurred. Please try again later.
      security:
        - bearer: []
components:
  schemas:
    UpdateBatchCallStatusRequest:
      type: object
      properties:
        action:
          type: string
          enum:
            - pause
            - resume
            - cancel
          description: >-
            pause stops new outbound calls and keeps the batch resumable; resume
            re-enqueues the remaining leads; cancel removes queued calls and
            cannot be resumed. cancel works from any state except completed or
            cancelled, including running.
          example: pause
      required:
        - action
    FilteredErrorResponse:
      type: object
      description: >-
        Error body on calls, batch calls, voices, languages and LLMs, which
        return only the message (and data for a coded refusal).
      properties:
        message:
          type: string
        data:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable refusal code.
          description: >-
            Present for a coded refusal: code and the details listed for that
            code.
        validation_errors:
          type: array
          description: >-
            Present when uploaded rows fail number validation (batch and
            workflow lead uploads): one group per distinct error.
          items:
            type: object
            properties:
              error:
                type: string
              rows:
                type: array
                items:
                  type: integer
                description: Row numbers with this error.
              phone_numbers:
                type: array
                items:
                  type: string
        invalid_row_count:
          type: integer
          description: 'Present with validation_errors: how many rows failed.'
      required:
        - message
  securitySchemes:
    bearer:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.