curl --request POST \
--url https://api.inbox.adraa.ai/api/v1/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templateName": "order_status_update",
"audience": {
"type": "group",
"groupId": "<string>"
},
"language": "en_US",
"parameters": [
"Sara",
"A-1043",
"Shipped"
]
}
'import requests
url = "https://api.inbox.adraa.ai/api/v1/broadcasts"
payload = {
"templateName": "order_status_update",
"audience": {
"type": "group",
"groupId": "<string>"
},
"language": "en_US",
"parameters": ["Sara", "A-1043", "Shipped"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateName: 'order_status_update',
audience: {type: 'group', groupId: '<string>'},
language: 'en_US',
parameters: ['Sara', 'A-1043', 'Shipped']
})
};
fetch('https://api.inbox.adraa.ai/api/v1/broadcasts', 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.inbox.adraa.ai/api/v1/broadcasts",
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([
'templateName' => 'order_status_update',
'audience' => [
'type' => 'group',
'groupId' => '<string>'
],
'language' => 'en_US',
'parameters' => [
'Sara',
'A-1043',
'Shipped'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.inbox.adraa.ai/api/v1/broadcasts"
payload := strings.NewReader("{\n \"templateName\": \"order_status_update\",\n \"audience\": {\n \"type\": \"group\",\n \"groupId\": \"<string>\"\n },\n \"language\": \"en_US\",\n \"parameters\": [\n \"Sara\",\n \"A-1043\",\n \"Shipped\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.inbox.adraa.ai/api/v1/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"templateName\": \"order_status_update\",\n \"audience\": {\n \"type\": \"group\",\n \"groupId\": \"<string>\"\n },\n \"language\": \"en_US\",\n \"parameters\": [\n \"Sara\",\n \"A-1043\",\n \"Shipped\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.inbox.adraa.ai/api/v1/broadcasts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateName\": \"order_status_update\",\n \"audience\": {\n \"type\": \"group\",\n \"groupId\": \"<string>\"\n },\n \"language\": \"en_US\",\n \"parameters\": [\n \"Sara\",\n \"A-1043\",\n \"Shipped\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"broadcast": {
"id": "cmbxh3c4d0006ph01u2v3w4x5",
"groupId": "cmbxh1a2b0004ph01q8r9s0t1",
"groupName": "VIP customers",
"channel": "whatsapp",
"templateName": "order_status_update",
"templateLanguage": "en_US",
"status": "completed",
"totalRecipients": 37,
"sentCount": 37,
"failedCount": 0,
"createdAt": "2026-06-15T12:00:00.000Z"
}
}{
"error": {
"code": "NO_WHATSAPP_RECIPIENTS",
"message": "No contacts in this audience have a WhatsApp conversation to deliver to"
}
}{
"error": {
"code": "INVALID_API_TOKEN",
"message": "Invalid or revoked API token"
}
}Send a broadcast to an audience
Sends an approved WhatsApp template to an audience defined inline. The audience is one of: a saved group, an ad-hoc set of contacts, a filter over contact/conversation attributes, or an imported list of recipients (phone numbers with per-row variables). Only contacts with a WhatsApp conversation are reached. Delivery is attempted per recipient; the response reports how many succeeded and failed.
Rate limit: 10 requests per minute.
curl --request POST \
--url https://api.inbox.adraa.ai/api/v1/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templateName": "order_status_update",
"audience": {
"type": "group",
"groupId": "<string>"
},
"language": "en_US",
"parameters": [
"Sara",
"A-1043",
"Shipped"
]
}
'import requests
url = "https://api.inbox.adraa.ai/api/v1/broadcasts"
payload = {
"templateName": "order_status_update",
"audience": {
"type": "group",
"groupId": "<string>"
},
"language": "en_US",
"parameters": ["Sara", "A-1043", "Shipped"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateName: 'order_status_update',
audience: {type: 'group', groupId: '<string>'},
language: 'en_US',
parameters: ['Sara', 'A-1043', 'Shipped']
})
};
fetch('https://api.inbox.adraa.ai/api/v1/broadcasts', 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.inbox.adraa.ai/api/v1/broadcasts",
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([
'templateName' => 'order_status_update',
'audience' => [
'type' => 'group',
'groupId' => '<string>'
],
'language' => 'en_US',
'parameters' => [
'Sara',
'A-1043',
'Shipped'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.inbox.adraa.ai/api/v1/broadcasts"
payload := strings.NewReader("{\n \"templateName\": \"order_status_update\",\n \"audience\": {\n \"type\": \"group\",\n \"groupId\": \"<string>\"\n },\n \"language\": \"en_US\",\n \"parameters\": [\n \"Sara\",\n \"A-1043\",\n \"Shipped\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.inbox.adraa.ai/api/v1/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"templateName\": \"order_status_update\",\n \"audience\": {\n \"type\": \"group\",\n \"groupId\": \"<string>\"\n },\n \"language\": \"en_US\",\n \"parameters\": [\n \"Sara\",\n \"A-1043\",\n \"Shipped\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.inbox.adraa.ai/api/v1/broadcasts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateName\": \"order_status_update\",\n \"audience\": {\n \"type\": \"group\",\n \"groupId\": \"<string>\"\n },\n \"language\": \"en_US\",\n \"parameters\": [\n \"Sara\",\n \"A-1043\",\n \"Shipped\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"broadcast": {
"id": "cmbxh3c4d0006ph01u2v3w4x5",
"groupId": "cmbxh1a2b0004ph01q8r9s0t1",
"groupName": "VIP customers",
"channel": "whatsapp",
"templateName": "order_status_update",
"templateLanguage": "en_US",
"status": "completed",
"totalRecipients": 37,
"sentCount": 37,
"failedCount": 0,
"createdAt": "2026-06-15T12:00:00.000Z"
}
}{
"error": {
"code": "NO_WHATSAPP_RECIPIENTS",
"message": "No contacts in this audience have a WhatsApp conversation to deliver to"
}
}{
"error": {
"code": "INVALID_API_TOKEN",
"message": "Invalid or revoked API token"
}
}Authorizations
Workspace API token created in Settings → API. Tokens start with adraa_.
Body
Name of an approved WhatsApp template.
512"order_status_update"
Who to send to. Exactly one shape.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
"en_US"
Default {{1}}, {{2}}, … values for group/contacts/filter audiences. Ignored for recipients rows that carry their own values.
1024["Sara", "A-1043", "Shipped"]
Response
Broadcast processed
Show child attributes
Show child attributes