Create Batch
curl --request POST \
--url https://api.bland.ai/v2/batches/create \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"call_objects": [
{}
],
"global": {},
"description": "<string>",
"status_webhook": "<string>"
}
'import requests
url = "https://api.bland.ai/v2/batches/create"
payload = {
"call_objects": [{}],
"global": {},
"description": "<string>",
"status_webhook": "<string>"
}
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
call_objects: [{}],
global: {},
description: '<string>',
status_webhook: '<string>'
})
};
fetch('https://api.bland.ai/v2/batches/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bland.ai/v2/batches/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'call_objects' => [
[
]
],
'global' => [
],
'description' => '<string>',
'status_webhook' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bland.ai/v2/batches/create"
payload := strings.NewReader("{\n \"call_objects\": [\n {}\n ],\n \"global\": {},\n \"description\": \"<string>\",\n \"status_webhook\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bland.ai/v2/batches/create")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"call_objects\": [\n {}\n ],\n \"global\": {},\n \"description\": \"<string>\",\n \"status_webhook\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v2/batches/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"call_objects\": [\n {}\n ],\n \"global\": {},\n \"description\": \"<string>\",\n \"status_webhook\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"batch_id": "8b8e8c57-9e6e-4e4d-84d2-9826b2268c22"
},
"errors": null
}
Batches
Create Batch
Create a new batch of calls using direct input.
POST
/
v2
/
batches
/
create
Create Batch
curl --request POST \
--url https://api.bland.ai/v2/batches/create \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '
{
"call_objects": [
{}
],
"global": {},
"description": "<string>",
"status_webhook": "<string>"
}
'import requests
url = "https://api.bland.ai/v2/batches/create"
payload = {
"call_objects": [{}],
"global": {},
"description": "<string>",
"status_webhook": "<string>"
}
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
call_objects: [{}],
global: {},
description: '<string>',
status_webhook: '<string>'
})
};
fetch('https://api.bland.ai/v2/batches/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bland.ai/v2/batches/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'call_objects' => [
[
]
],
'global' => [
],
'description' => '<string>',
'status_webhook' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bland.ai/v2/batches/create"
payload := strings.NewReader("{\n \"call_objects\": [\n {}\n ],\n \"global\": {},\n \"description\": \"<string>\",\n \"status_webhook\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bland.ai/v2/batches/create")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"call_objects\": [\n {}\n ],\n \"global\": {},\n \"description\": \"<string>\",\n \"status_webhook\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v2/batches/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"call_objects\": [\n {}\n ],\n \"global\": {},\n \"description\": \"<string>\",\n \"status_webhook\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"batch_id": "8b8e8c57-9e6e-4e4d-84d2-9826b2268c22"
},
"errors": null
}
Headers
string
required
Your API key for authentication.
Body
array
A list of individual call objects to include in the batch. Each object follows the same schema as
/v1/calls.Example
"call_objects": [
{
"phone_number": "+1234567890",
"task": "Say hello to the nice person!",
"start_time": "2026-01-01 12:00:00-05:00",
// Provide a UUID v7 Compliant ID for this Call ahead of time.
// Requires entitlements to use. Contact your Account Executive for more information.
"b_cid": "<UUID v7 Compliant ID>"
// Remainder of /v1/call properties ...
},
{
"phone_number": "+1234567891",
"task": "Say hello to the bad person!",
"record": false,
"start_time": "2026-01-01 1:00:00-05:00" //timezone is optional, defaults to UTC
// /v1/call properties
}
]
object
required
Global call properties to apply to all
Required keys:
call_objects, unless overridden per entry. Required keys:
- Must include at least one of:
"task"or"pathway_id".
Forbidden keys: "phone_number"is not allowed in the global object.
Example
"global": {
"task": "Say hello to the nice person!",
"record": true,
"start_time": "2026-01-01 12:00:00-05:00" //timezone is optional, defaults to UTC
// /v1/call properties
}
string
A short label for the batch shown in the dashboard. Maximum 60 characters. Defaults to
"Untitled Batch" if not provided.string
Optional URL to receive batch status updates. We send a single POST per lifecycle phase and one final POST when the batch completes or fails. Payload is JSON with
batch_id, status, and timestamp; final events include calls_total / calls_successful / calls_failed or code and reason on failure. Your endpoint should respond with 200 within a few seconds; we wait up to 10 seconds per call. See Status webhook below for payload details.Response
object
The response includes the
batch_id of the newly created batch.string
The unique identifier for the batch.
null
Always
null on success.{
"data": {
"batch_id": "8b8e8c57-9e6e-4e4d-84d2-9826b2268c22"
},
"errors": null
}
Status webhook
If you providestatus_webhook, we POST to that URL at each lifecycle phase and once when the batch finishes. All requests use Content-Type: application/json.
Status values: validating | dispatching | in_progress | in_progress_chunked | waiting_for_scheduled_calls | completed | failed | completed_partial
Common fields on every request: batch_id (string), status (string), timestamp (ISO 8601). Progress events may include message (string). Final events include call counts or error details as below.
Progress examples:
Validating
{ "batch_id": "42eb41ed-1842-40c3-b2e6-47d690c179ad", "status": "validating", "timestamp": "2026-02-20T15:00:05.123Z" }
In progress (with message)
{ "batch_id": "42eb41ed-1842-40c3-b2e6-47d690c179ad", "status": "in_progress", "message": "Requested: 100. Validated: 100. Dispatched: 100. CPS: 12.50.", "timestamp": "2026-02-20T15:00:18.789Z" }
Completed
{ "batch_id": "42eb41ed-1842-40c3-b2e6-47d690c179ad", "status": "completed", "calls_total": 100, "calls_successful": 98, "calls_failed": 2, "timestamp": "2026-02-20T15:30:00.000Z" }
Failed
{ "batch_id": "42eb41ed-1842-40c3-b2e6-47d690c179ad", "status": "failed", "code": "source_invalid", "reason": "Entry #7 did not have a phone number.", "timestamp": "2026-02-20T15:00:10.000Z" }
Completed partial (e.g. timeout)
{ "batch_id": "42eb41ed-1842-40c3-b2e6-47d690c179ad", "status": "completed_partial", "code": "batch_early_exit", "reason": "Condition not met within 86400 seconds", "calls_total": 50, "calls_successful": 45, "calls_failed": 5, "timestamp": "2026-02-21T15:00:00.000Z" }
Docs for agents: llms.txt
Was this page helpful?