Batch Calls

Update Batch Call Status

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.

patch/v1/batch-calls/{id}/status

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/batch-calls/{id}/status
  • Auth: HTTP bearer

Path parameters

idstring required
Example:batch_abc123

Batch call ID

Request body

action'pause' | 'resume' | 'cancel' required

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 request

{
  "action": "pause"
}

Response

Batch call status updated successfully.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.