Update Batch Call Status - DialNexa Documentation

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"
}
'

{
  "success": true,
  "message": "Campaign paused successfully",
  "campaign": {
    "id": "batch_abc123",
    "status": "paused",
    "title": "Q3 Follow-up Batch"
  },
  "affectedCalls": {
    "initiated": 0,
    "queued": 0,
    "removedFromQueue": 12,
    "cancelledCallLogs": 0,
    "resumedCallLogs": 0
  }
}

{
  "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

Recommended. This endpoint is part of the public /v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.

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.

When To Use Update Batch Call Status

Use pause when new calls should stop, but calls already in progress can finish.
Use resume when a paused batch should continue calling remaining leads.
Use cancel when the batch should stop permanently and queued calls should be removed.

Status Actions

Action	Result
`pause`	Stops new outbound calls and keeps the batch resumable.
`resume`	Re-enqueues remaining leads for a paused batch.
`cancel`	Removes queued calls and prevents the batch from resuming.

Verify The Result

After the request succeeds, check the returned campaign.status value. You can also call Get Batch Call to inspect the call logs and confirm that no new calls are being created after a pause or cancel action.

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.

success

boolean

Example:

true

message

string

Example:

"Campaign paused successfully"

campaign

object

Show child attributes

affectedCalls

object

Show child attributes

Workflows overviewInspect, activate, pause, and operate DialNexa v1 workflows and their leads.

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"
}
'

{
  "success": true,
  "message": "Campaign paused successfully",
  "campaign": {
    "id": "batch_abc123",
    "status": "paused",
    "title": "Q3 Follow-up Batch"
  },
  "affectedCalls": {
    "initiated": 0,
    "queued": 0,
    "removedFromQueue": 12,
    "cancelledCallLogs": 0,
    "resumedCallLogs": 0
  }
}

{
  "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"
}

​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