POST
Resume Whatsapp 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
agent_plan
StoredAgentPlan · object | null
required

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.

counts
WhatsAppBatchCounts · object
required
created_at
string<date-time>
required
delivery_attempts
integer
required
delivery_retry_after_hours
integer
required
failure_reason
string | null
required
finished_at
string<date-time> | null
required
id
string<uuid>
required
input_columns
string[]
required
integration_id
string<uuid> | null
required
integration_name
string | null
required
name
string
required
next_send_at
string<date-time> | null
required
next_send_reason
enum<string> | null
required
Available options:
start,
window,
daily_cap,
retry,
gap
own_agent
boolean
required
send_daily_cap
FixedDailyCap · object
required

The same limit every day.

send_daily_cap_today
integer | null
required
send_gap_seconds
integer
required
sender_e164
string | null
required
sent_today
integer
required
start_at
string<date-time> | null
required
started_at
string<date-time> | null
required
status
enum<string>
required
Available options:
draft,
scheduled,
sending,
paused,
completed,
canceled,
failed
template
WhatsAppTemplateSnapshot · object
required

The whole message as a batch sends it: header, body, footer and buttons.

timezone
string
required
to_column
string
required
variable_map
Variable Map · object
required
vars
Vars · object | null
required
window
TimeWindow · object | null
required

The hours a list may run in, on the list's own clock.

Shared rather than duplicated, for the same reason window_state is: a call batch and an email send run store the same three values under the same names and must not each get their own copy of the rules. The field that carries one is named for what it gates — calling_window on a campaign, window on an email batch and its runs.

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