curl --request POST 'https://api.brightalk.ai/batches/bat_demo_001/pause' \
--header "Authorization: Bearer $BRIGHTALK_API_KEY" \
--header "Brightalk-Version: 2026-07-16" \
--header "Content-Type: application/json" \
--data '{}'const response = await fetch("https://api.brightalk.ai/batches/bat_demo_001/pause", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
console.log(response.status, await response.json());import os
import requests
response = requests.request(
"POST",
"https://api.brightalk.ai/batches/bat_demo_001/pause",
headers={
"Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
},
json={},
)
print(response.status_code, response.json())Pause future batch dispatch
Pauses future recipient dispatch without promising to stop work already in progress. An optional Idempotency-Key makes the result replayable; the raw JSON body is limited to 1 MiB. Every response includes Brightalk-Version and X-Request-Id; rate-limited responses also expose the effective bucket counters.
curl --request POST 'https://api.brightalk.ai/batches/bat_demo_001/pause' \
--header "Authorization: Bearer $BRIGHTALK_API_KEY" \
--header "Brightalk-Version: 2026-07-16" \
--header "Content-Type: application/json" \
--data '{}'const response = await fetch("https://api.brightalk.ai/batches/bat_demo_001/pause", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
console.log(response.status, await response.json());import os
import requests
response = requests.request(
"POST",
"https://api.brightalk.ai/batches/bat_demo_001/pause",
headers={
"Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
},
json={},
)
print(response.status_code, response.json())Authorizations
Use a server-side Brightalk API key in the Authorization header.
Headers
Selects the date-based API version. Omission uses the organization’s pinned default.
"2026-07-16"A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}. Invalid values are replaced.
64^[A-Za-z0-9._:-]{1,64}$Optionally makes this state transition replayable for 24 hours.
1 - 255^(?=.{1,255}$)[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$Path Parameters
The opaque Batch identifier. An opaque resource identifier.
1 - 255"bat_demo_001"
Body
JSON request body. The raw encoded body is limited to 1 MiB and unknown fields are rejected.
The body is of type object.
Response
Batch paused or current terminal state returned.
An opaque resource identifier.
1 - 255"bat_demo_001"
draft, scheduled, queued, in_progress, paused, completed, failed, cancelled "Renewal reminders"
An opaque resource identifier.
1 - 255"agt_demo_001"
x >= 02
x >= 02
x >= 00
x >= 00
x >= 00
x >= 00
x >= 00
x >= 00
x >= 00
x >= 00
When the batch was created.
"2026-07-20T01:00:00Z"
When the batch was last updated.
"2026-07-20T01:00:00Z"
The configured earliest start instant.
"2026-07-20T01:00:00Z"
One contiguous daily calling window. The runtime requires end_time to be later than start_time; x-brightalk-end-after-start records that checker-only cross-field rule because standard JSON Schema cannot compare two time strings. This window can only NARROW the organization outbound calling policy configured in the app; calls go out where the two overlap, so a window wider than the policy still dials only during the policy's hours.
Show child attributes
Show child attributes
When dispatch began.
"2026-07-20T01:00:00Z"
When the batch was paused.
"2026-07-20T01:00:00Z"
When the batch reached completion.
"2026-07-20T01:00:00Z"
When the batch was cancelled.
"2026-07-20T01:00:00Z"