Update Batch Call Status

PATCH

batch-calls

{id}

status

curl --request PATCH \
  --url https://api.dialnexa.com/v1/batch-calls/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "pause"
}
'

{}

{
  "statusCode": 400,
  "message": "Invalid action. Must be one of: pause, resume, cancel",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "You do not have permission to access this resource",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Batch call not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

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. In the current lifecycle, running is the only active sending state, so pause a running batch before cancelling it permanently.

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 non-running batch should stop permanently and queued calls should be removed. If the batch is running, pause it first, then cancel.

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 start time and queue availability.
`cancel`	Removes queued calls and prevents the batch from resuming. For a `running` batch, pause first and cancel from `paused`.

Verify The Result

The current API-key success response is an empty object. After HTTP 200, use List Batch Calls to check the batch status and List Calls with batch_call_id to inspect dispatch activity. If the listed batch is waiting, it is accepted but is not yet the active sender for the organization. See Batch Call Retries And Statuses 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.
403 Forbidden means the batch call does not belong to the authenticated workspace.
404 Not Found means the batch call ID was not found.

Create Batch Call: upload leads and create a batch.
List Batch Calls: find batch IDs in your workspace.
Get Batch Call: inspect calls generated by a batch.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Batch call ID

Example:

"batch_abc123"

Body

application/json

action

enum<string>

required

The status transition to apply.

Available options:

pause,

resume,

cancel

Example:

"pause"

Response

Batch call status updated successfully.

The response is of type object.

curl --request PATCH \
  --url https://api.dialnexa.com/v1/batch-calls/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "pause"
}
'

{}

{
  "statusCode": 400,
  "message": "Invalid action. Must be one of: pause, resume, cancel",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "You do not have permission to access this resource",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Batch call not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Overview

Endpoints

When To Use Update Batch Call Status

Status Actions

Verify The Result

Common Errors

Authorizations

Path Parameters

Body

Response

​When To Use Update Batch Call Status

​Status Actions

​Verify The Result

​Common Errors

​Related Endpoints

Authorizations

Path Parameters

Body

Response

When To Use Update Batch Call Status

Status Actions

Verify The Result

Common Errors

Related Endpoints