cURL
curl --request POST 'https://api.brightalk.ai/bulk-tasks' \
--header "Authorization: Bearer $BRIGHTALK_API_KEY" \
--header "Brightalk-Version: 2026-07-16" \
--header "Content-Type: application/json" \
--header "Idempotency-Key: bulk-example-1" \
--data '{"kind":"sms","total_recipients":10000,"recipient_format":"recipients","upload_chunk_size":1000,"options":{"message":"Hello {{name}}","test_mode":true}}'const response = await fetch("https://api.brightalk.ai/bulk-tasks", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.BRIGHTALK_API_KEY}`,
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
"Idempotency-Key": "bulk-example-1"
},
body: JSON.stringify({"kind":"sms","total_recipients":10000,"recipient_format":"recipients","upload_chunk_size":1000,"options":{"message":"Hello {{name}}","test_mode":true}}),
});
console.log(response.status, await response.json());import os
import requests
response = requests.request(
"POST",
"https://api.brightalk.ai/bulk-tasks",
headers={
"Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
"Idempotency-Key": "bulk-example-1"
},
json={"kind":"sms","total_recipients":10000,"recipient_format":"recipients","upload_chunk_size":1000,"options":{"message":"Hello {{name}}","test_mode":True}},
)
print(response.status_code, response.json()){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "calls",
"recipient_format": "contact_ids",
"status": "uploading",
"total_recipients": 4503599627370495,
"uploaded_recipients": 4503599627370495,
"submitted_recipients": 4503599627370495,
"settled_recipients": 4503599627370495,
"failed_recipients": 4503599627370495,
"unknown_recipients": 4503599627370495,
"total_parts": 4503599627370495,
"submitted_parts": 4503599627370495,
"failed_parts": 4503599627370495,
"error_code": "<string>",
"upload_chunk_size": 500,
"created_at": "<string>"
}Batches
Create a large task
Create a task for up to 100000 SMS or call recipients. Options use the existing batch fields. No messages or calls are sent until all chunks are uploaded and start is requested. upload_chunk_size defaults to 1000; choose a smaller value for large per-recipient variables. Every request must fit the 1 MiB JSON limit.
POST
/
bulk-tasks
cURL
curl --request POST 'https://api.brightalk.ai/bulk-tasks' \
--header "Authorization: Bearer $BRIGHTALK_API_KEY" \
--header "Brightalk-Version: 2026-07-16" \
--header "Content-Type: application/json" \
--header "Idempotency-Key: bulk-example-1" \
--data '{"kind":"sms","total_recipients":10000,"recipient_format":"recipients","upload_chunk_size":1000,"options":{"message":"Hello {{name}}","test_mode":true}}'const response = await fetch("https://api.brightalk.ai/bulk-tasks", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.BRIGHTALK_API_KEY}`,
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
"Idempotency-Key": "bulk-example-1"
},
body: JSON.stringify({"kind":"sms","total_recipients":10000,"recipient_format":"recipients","upload_chunk_size":1000,"options":{"message":"Hello {{name}}","test_mode":true}}),
});
console.log(response.status, await response.json());import os
import requests
response = requests.request(
"POST",
"https://api.brightalk.ai/bulk-tasks",
headers={
"Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
"Idempotency-Key": "bulk-example-1"
},
json={"kind":"sms","total_recipients":10000,"recipient_format":"recipients","upload_chunk_size":1000,"options":{"message":"Hello {{name}}","test_mode":True}},
)
print(response.status_code, response.json()){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "calls",
"recipient_format": "contact_ids",
"status": "uploading",
"total_recipients": 4503599627370495,
"uploaded_recipients": 4503599627370495,
"submitted_recipients": 4503599627370495,
"settled_recipients": 4503599627370495,
"failed_recipients": 4503599627370495,
"unknown_recipients": 4503599627370495,
"total_parts": 4503599627370495,
"submitted_parts": 4503599627370495,
"failed_parts": 4503599627370495,
"error_code": "<string>",
"upload_chunk_size": 500,
"created_at": "<string>"
}Authorizations
Headers
Body
application/json
- Option 1
- Option 2
Response
Task state returned. Submission is not delivery or completion.