POST
Pause Call Batch

Authorizations

Authorization
string
header
required

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

Path Parameters

batch_id
string<uuid>
required

Response

Successful Response

agent_id
string<uuid> | null
required
agent_name
string | null
required
calling_window
CallingWindow · object | null
required

The hours a batch may dial in, on the batch's own clock.

A window that crosses midnight (21:0006:00) is valid and means exactly what an evening consumer-calling window means: the day check applies to the start side, so 21:0006:00 on days: [5] runs Friday 21:00 through Saturday 06:00.

counts
CallBatchCounts · object
required
created_at
string<date-time>
required
ended_at
string<date-time> | null
required
failure_reason
string | null
required
from_e164
string | null
required
from_phone_number_id
string<uuid> | null
required
id
string<uuid>
required
max_attempts
integer
required
max_concurrency
integer
required
name
string
required
next_dial_at
string<date-time> | null
required
retry_after_minutes
integer
required
start_at
string<date-time> | null
required
started_at
string<date-time> | null
required
status
enum<string>
required
Available options:
scheduled,
running,
paused,
completed,
canceled,
failed
timezone
string
required
agent_plan
StoredAgentPlan · object | null

What a call ran, frozen at the moment it started.

Written only when the call differs from "the published agent, as-is" — so a null agent_plan means exactly that. members[0] is the agent that answered.

vars
Vars · object | null