Send bulk template
curl --request POST \
--url https://api.nuvia.ai/v1/messages/send-bulk-template \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'inboxId=<string>' \
--form 'templateName=<string>' \
--form languageCode=pt_BR \
--form 'components={
"index": "<string>",
"parameters": [
{
"image": {
"link": "<string>",
"id": "<string>"
},
"document": {
"link": "<string>",
"filename": "<string>"
},
"video": {
"link": "<string>"
},
"text": "<string>",
"value": "<string>",
"link": "<string>",
"imageUrl": "<string>",
"imageId": "<string>",
"documentUrl": "<string>",
"documentFilename": "<string>",
"videoUrl": "<string>",
"currencyCode": "<string>",
"currencyAmount": 123,
"dateTime": "<string>",
"payload": "<string>",
"parameter_name": "<string>",
"variable_ref": "<string>"
}
]
}' \
--form 'contacts={
"name": "<string>",
"phone": "<string>"
}' \
--form who_will_answer=AGENT \
--form 'agentToActivate=<string>' \
--form keep_existing_assignment=false \
--form 'owner_user_id=<string>' \
--form 'attendant_user_id=<string>'import requests
url = "https://api.nuvia.ai/v1/messages/send-bulk-template"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('inboxId', '<string>');
form.append('templateName', '<string>');
form.append('languageCode', 'pt_BR');
form.append('components', '{
"index": "<string>",
"parameters": [
{
"image": {
"link": "<string>",
"id": "<string>"
},
"document": {
"link": "<string>",
"filename": "<string>"
},
"video": {
"link": "<string>"
},
"text": "<string>",
"value": "<string>",
"link": "<string>",
"imageUrl": "<string>",
"imageId": "<string>",
"documentUrl": "<string>",
"documentFilename": "<string>",
"videoUrl": "<string>",
"currencyCode": "<string>",
"currencyAmount": 123,
"dateTime": "<string>",
"payload": "<string>",
"parameter_name": "<string>",
"variable_ref": "<string>"
}
]
}');
form.append('contacts', '{
"name": "<string>",
"phone": "<string>"
}');
form.append('who_will_answer', 'AGENT');
form.append('agentToActivate', '<string>');
form.append('keep_existing_assignment', 'false');
form.append('owner_user_id', '<string>');
form.append('attendant_user_id', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.nuvia.ai/v1/messages/send-bulk-template', 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.nuvia.ai/v1/messages/send-bulk-template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.nuvia.ai/v1/messages/send-bulk-template"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.nuvia.ai/v1/messages/send-bulk-template")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/messages/send-bulk-template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"totalProcessed": 123,
"sentCount": 123,
"errorCount": 123,
"errors": [
{
"row": 123,
"contact": "<string>",
"error": "<string>"
}
],
"sentContacts": [
{
"conversationId": "<string>",
"phoneNumber": "<string>"
}
]
}Mensagens
Send bulk template
Sends an approved WhatsApp template to multiple contacts in a single
request (multipart/form-data).
Contacts come via the contacts field (JSON) or through a CSV/XLSX file in the
file field, with the columns name and phone — one of the two is required.
The template parameters go in components and must match the approved
template in number and type.
Processing is synchronous and partial: the response returns totalProcessed,
sentCount, errorCount, the contacts sent, and the list of errors per
row. A contact with an error does not stop the others.
Since these are templates, sends are valid outside the 24-hour window, but remain subject to the WhatsApp account tier’s daily limit.
POST
/
v1
/
messages
/
send-bulk-template
Send bulk template
curl --request POST \
--url https://api.nuvia.ai/v1/messages/send-bulk-template \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'inboxId=<string>' \
--form 'templateName=<string>' \
--form languageCode=pt_BR \
--form 'components={
"index": "<string>",
"parameters": [
{
"image": {
"link": "<string>",
"id": "<string>"
},
"document": {
"link": "<string>",
"filename": "<string>"
},
"video": {
"link": "<string>"
},
"text": "<string>",
"value": "<string>",
"link": "<string>",
"imageUrl": "<string>",
"imageId": "<string>",
"documentUrl": "<string>",
"documentFilename": "<string>",
"videoUrl": "<string>",
"currencyCode": "<string>",
"currencyAmount": 123,
"dateTime": "<string>",
"payload": "<string>",
"parameter_name": "<string>",
"variable_ref": "<string>"
}
]
}' \
--form 'contacts={
"name": "<string>",
"phone": "<string>"
}' \
--form who_will_answer=AGENT \
--form 'agentToActivate=<string>' \
--form keep_existing_assignment=false \
--form 'owner_user_id=<string>' \
--form 'attendant_user_id=<string>'import requests
url = "https://api.nuvia.ai/v1/messages/send-bulk-template"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('inboxId', '<string>');
form.append('templateName', '<string>');
form.append('languageCode', 'pt_BR');
form.append('components', '{
"index": "<string>",
"parameters": [
{
"image": {
"link": "<string>",
"id": "<string>"
},
"document": {
"link": "<string>",
"filename": "<string>"
},
"video": {
"link": "<string>"
},
"text": "<string>",
"value": "<string>",
"link": "<string>",
"imageUrl": "<string>",
"imageId": "<string>",
"documentUrl": "<string>",
"documentFilename": "<string>",
"videoUrl": "<string>",
"currencyCode": "<string>",
"currencyAmount": 123,
"dateTime": "<string>",
"payload": "<string>",
"parameter_name": "<string>",
"variable_ref": "<string>"
}
]
}');
form.append('contacts', '{
"name": "<string>",
"phone": "<string>"
}');
form.append('who_will_answer', 'AGENT');
form.append('agentToActivate', '<string>');
form.append('keep_existing_assignment', 'false');
form.append('owner_user_id', '<string>');
form.append('attendant_user_id', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.nuvia.ai/v1/messages/send-bulk-template', 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.nuvia.ai/v1/messages/send-bulk-template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.nuvia.ai/v1/messages/send-bulk-template"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.nuvia.ai/v1/messages/send-bulk-template")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuvia.ai/v1/messages/send-bulk-template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"inboxId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"languageCode\"\r\n\r\npt_BR\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"components\"\r\n\r\n{\r\n \"index\": \"<string>\",\r\n \"parameters\": [\r\n {\r\n \"image\": {\r\n \"link\": \"<string>\",\r\n \"id\": \"<string>\"\r\n },\r\n \"document\": {\r\n \"link\": \"<string>\",\r\n \"filename\": \"<string>\"\r\n },\r\n \"video\": {\r\n \"link\": \"<string>\"\r\n },\r\n \"text\": \"<string>\",\r\n \"value\": \"<string>\",\r\n \"link\": \"<string>\",\r\n \"imageUrl\": \"<string>\",\r\n \"imageId\": \"<string>\",\r\n \"documentUrl\": \"<string>\",\r\n \"documentFilename\": \"<string>\",\r\n \"videoUrl\": \"<string>\",\r\n \"currencyCode\": \"<string>\",\r\n \"currencyAmount\": 123,\r\n \"dateTime\": \"<string>\",\r\n \"payload\": \"<string>\",\r\n \"parameter_name\": \"<string>\",\r\n \"variable_ref\": \"<string>\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contacts\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"who_will_answer\"\r\n\r\nAGENT\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentToActivate\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keep_existing_assignment\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"owner_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attendant_user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"totalProcessed": 123,
"sentCount": 123,
"errorCount": 123,
"errors": [
{
"row": 123,
"contact": "<string>",
"error": "<string>"
}
],
"sentContacts": [
{
"conversationId": "<string>",
"phoneNumber": "<string>"
}
]
}Authorizations
Token JWT de autenticação
Headers
Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.
Body
multipart/form-data
ID of the inbox/WhatsApp connection to use for sending
Minimum string length:
1Name of the template registered on WhatsApp Business
Minimum string length:
1Template language code (format: pt_BR, en_US, en, etc.)
List of the template's components with their parameters/variables. Use it to customize header, body, and buttons with dynamic data.
Show child attributes
Show child attributes
List of contacts that will receive the template. Optional if you send a CSV/Excel file with the contacts.
Show child attributes
Show child attributes
Defines who will answer after the template is sent. Values: AGENT (AI agent), HUMAN (human attendant). Default: AGENT
Available options:
AGENT, HUMAN, UNASSIGNED ID of the AI agent that will be activated to answer. Used together with who_will_answer=AGENT
If true, preserves the conversation's current assignment: nothing is written to owner/agent and who_will_answer is NOT applied (the AI does not take over). Default false so as not to change the behavior of existing integrations via API key — the support front end sends true.
ID of the user who owns the conversation. null is the explicit choice of "Unassigned" (authorizes clearing the current owner); absent means the caller did not weigh in on the assignment.
ID of the attendant user. Applies when who_will_answer=HUMAN. null is an explicit "Unassigned"; absent means the caller did not weigh in. The owner takes precedence: conversation.user = owner ?? attendant.
Response
Bulk send executed successfully (returns detailed statistics)
Total contacts processed
Number of messages sent successfully
Number of errors during the send
Detailed list of errors that occurred
Show child attributes
Show child attributes
List of contacts that received the message successfully
Show child attributes
Show child attributes