Send quick bulk SMS to multiple contacts
curl --request POST \
--url https://your-instance.example.com/api/messages/quick-bulk-send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactIds": [
"65c2d0e0f0a0b0c0d0e0f0a0",
"65c2d0e0f0a0b0c0d0e0f0a1"
],
"message": "Hi {{firstName}}, our team will be in touch shortly."
}
'import requests
url = "https://your-instance.example.com/api/messages/quick-bulk-send"
payload = {
"contactIds": ["65c2d0e0f0a0b0c0d0e0f0a0", "65c2d0e0f0a0b0c0d0e0f0a1"],
"message": "Hi {{firstName}}, our team will be in touch shortly."
}
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({
contactIds: ['65c2d0e0f0a0b0c0d0e0f0a0', '65c2d0e0f0a0b0c0d0e0f0a1'],
message: 'Hi {{firstName}}, our team will be in touch shortly.'
})
};
fetch('https://your-instance.example.com/api/messages/quick-bulk-send', 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://your-instance.example.com/api/messages/quick-bulk-send",
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([
'contactIds' => [
'65c2d0e0f0a0b0c0d0e0f0a0',
'65c2d0e0f0a0b0c0d0e0f0a1'
],
'message' => 'Hi {{firstName}}, our team will be in touch shortly.'
]),
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://your-instance.example.com/api/messages/quick-bulk-send"
payload := strings.NewReader("{\n \"contactIds\": [\n \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"65c2d0e0f0a0b0c0d0e0f0a1\"\n ],\n \"message\": \"Hi {{firstName}}, our team will be in touch shortly.\"\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://your-instance.example.com/api/messages/quick-bulk-send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactIds\": [\n \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"65c2d0e0f0a0b0c0d0e0f0a1\"\n ],\n \"message\": \"Hi {{firstName}}, our team will be in touch shortly.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/messages/quick-bulk-send")
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 \"contactIds\": [\n \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"65c2d0e0f0a0b0c0d0e0f0a1\"\n ],\n \"message\": \"Hi {{firstName}}, our team will be in touch shortly.\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"summary": {
"total": 2,
"success": 1,
"failed": 1
},
"results": [
{
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"success": true,
"name": "Jane Doe",
"messageId": "SMxxx",
"messageDocId": "67d0a0b0c0d0e0f0a0b0c0d0",
"status": "queued"
},
{
"contactId": "65c2d0e0f0a0b0c0d0e0f0a1",
"success": false,
"name": "John Smith",
"error": "Invalid phone number"
}
]
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}Messages
Send quick bulk SMS to multiple contacts
Fan-out send of a single SMS body (or templated body via templateId) to up to N contacts in one request. Returns a per-contact result list with success/error so the UI can surface partial failures.
POST
/
api
/
messages
/
quick-bulk-send
Send quick bulk SMS to multiple contacts
curl --request POST \
--url https://your-instance.example.com/api/messages/quick-bulk-send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactIds": [
"65c2d0e0f0a0b0c0d0e0f0a0",
"65c2d0e0f0a0b0c0d0e0f0a1"
],
"message": "Hi {{firstName}}, our team will be in touch shortly."
}
'import requests
url = "https://your-instance.example.com/api/messages/quick-bulk-send"
payload = {
"contactIds": ["65c2d0e0f0a0b0c0d0e0f0a0", "65c2d0e0f0a0b0c0d0e0f0a1"],
"message": "Hi {{firstName}}, our team will be in touch shortly."
}
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({
contactIds: ['65c2d0e0f0a0b0c0d0e0f0a0', '65c2d0e0f0a0b0c0d0e0f0a1'],
message: 'Hi {{firstName}}, our team will be in touch shortly.'
})
};
fetch('https://your-instance.example.com/api/messages/quick-bulk-send', 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://your-instance.example.com/api/messages/quick-bulk-send",
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([
'contactIds' => [
'65c2d0e0f0a0b0c0d0e0f0a0',
'65c2d0e0f0a0b0c0d0e0f0a1'
],
'message' => 'Hi {{firstName}}, our team will be in touch shortly.'
]),
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://your-instance.example.com/api/messages/quick-bulk-send"
payload := strings.NewReader("{\n \"contactIds\": [\n \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"65c2d0e0f0a0b0c0d0e0f0a1\"\n ],\n \"message\": \"Hi {{firstName}}, our team will be in touch shortly.\"\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://your-instance.example.com/api/messages/quick-bulk-send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactIds\": [\n \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"65c2d0e0f0a0b0c0d0e0f0a1\"\n ],\n \"message\": \"Hi {{firstName}}, our team will be in touch shortly.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/messages/quick-bulk-send")
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 \"contactIds\": [\n \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"65c2d0e0f0a0b0c0d0e0f0a1\"\n ],\n \"message\": \"Hi {{firstName}}, our team will be in touch shortly.\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"summary": {
"total": 2,
"success": 1,
"failed": 1
},
"results": [
{
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"success": true,
"name": "Jane Doe",
"messageId": "SMxxx",
"messageDocId": "67d0a0b0c0d0e0f0a0b0c0d0",
"status": "queued"
},
{
"contactId": "65c2d0e0f0a0b0c0d0e0f0a1",
"success": false,
"name": "John Smith",
"error": "Invalid phone number"
}
]
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Download an attachment with forced Content-DispositionUpload an attachment to R2 storage (tiered auth)
⌘I