Emails
Batch email
POST
/
v1
/
emails
/
batch
cURL
curl --request POST \
--url https://app.usesend.com/api/v1/emails/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"to": "<string>",
"from": "<string>",
"subject": "<string>",
"templateId": "<string>",
"variables": {},
"replyTo": "<string>",
"cc": "<string>",
"bcc": "<string>",
"text": "<string>",
"html": "<string>",
"headers": {},
"attachments": [
{
"filename": "<string>",
"content": "<string>"
}
],
"scheduledAt": "2023-11-07T05:31:56Z",
"inReplyToId": "<string>"
}
]
'import requests
url = "https://app.usesend.com/api/v1/emails/batch"
payload = [
{
"to": "<string>",
"from": "<string>",
"subject": "<string>",
"templateId": "<string>",
"variables": {},
"replyTo": "<string>",
"cc": "<string>",
"bcc": "<string>",
"text": "<string>",
"html": "<string>",
"headers": {},
"attachments": [
{
"filename": "<string>",
"content": "<string>"
}
],
"scheduledAt": "2023-11-07T05:31:56Z",
"inReplyToId": "<string>"
}
]
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([
{
to: '<string>',
from: '<string>',
subject: '<string>',
templateId: '<string>',
variables: {},
replyTo: '<string>',
cc: '<string>',
bcc: '<string>',
text: '<string>',
html: '<string>',
headers: {},
attachments: [{filename: '<string>', content: '<string>'}],
scheduledAt: '2023-11-07T05:31:56Z',
inReplyToId: '<string>'
}
])
};
fetch('https://app.usesend.com/api/v1/emails/batch', 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://app.usesend.com/api/v1/emails/batch",
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([
[
'to' => '<string>',
'from' => '<string>',
'subject' => '<string>',
'templateId' => '<string>',
'variables' => [
],
'replyTo' => '<string>',
'cc' => '<string>',
'bcc' => '<string>',
'text' => '<string>',
'html' => '<string>',
'headers' => [
],
'attachments' => [
[
'filename' => '<string>',
'content' => '<string>'
]
],
'scheduledAt' => '2023-11-07T05:31:56Z',
'inReplyToId' => '<string>'
]
]),
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://app.usesend.com/api/v1/emails/batch"
payload := strings.NewReader("[\n {\n \"to\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"templateId\": \"<string>\",\n \"variables\": {},\n \"replyTo\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"headers\": {},\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"inReplyToId\": \"<string>\"\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://app.usesend.com/api/v1/emails/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"to\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"templateId\": \"<string>\",\n \"variables\": {},\n \"replyTo\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"headers\": {},\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"inReplyToId\": \"<string>\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.usesend.com/api/v1/emails/batch")
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 {\n \"to\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"templateId\": \"<string>\",\n \"variables\": {},\n \"replyTo\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"headers\": {},\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"inReplyToId\": \"<string>\"\n }\n]"
response = http.request(request)
puts response.read_body{
"data": [
{
"emailId": "<string>"
}
]
}Send up to 100 emails in a single request.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Pass the optional Idempotency-Key header to make the request safe to retry. The key can be up to 256 characters. The server stores the canonical request body and behaves as follows:
- Same key + same request body → returns the original emailId with 200 OK without re-sending.
- Same key + different request body → returns 409 Conflict with code: NOT_UNIQUE so you can detect the mismatch.
- Same key while another request is still being processed → returns 409 Conflict; retry after a short delay or once the first request completes.
Entries expire after 24 hours. Use a unique key per logical send (for example, an order or signup ID).
Required string length:
1 - 256Body
application/json
Maximum array length:
100Optional when templateId is provided
Minimum string length:
1ID of a template from the dashboard
Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
1Custom headers to included with the emails
Show child attributes
Show child attributes
Maximum array length:
10Show child attributes
Show child attributes
Response
200 - application/json
List of successfully created email IDs
Show child attributes
Show child attributes
⌘I
cURL
curl --request POST \
--url https://app.usesend.com/api/v1/emails/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"to": "<string>",
"from": "<string>",
"subject": "<string>",
"templateId": "<string>",
"variables": {},
"replyTo": "<string>",
"cc": "<string>",
"bcc": "<string>",
"text": "<string>",
"html": "<string>",
"headers": {},
"attachments": [
{
"filename": "<string>",
"content": "<string>"
}
],
"scheduledAt": "2023-11-07T05:31:56Z",
"inReplyToId": "<string>"
}
]
'import requests
url = "https://app.usesend.com/api/v1/emails/batch"
payload = [
{
"to": "<string>",
"from": "<string>",
"subject": "<string>",
"templateId": "<string>",
"variables": {},
"replyTo": "<string>",
"cc": "<string>",
"bcc": "<string>",
"text": "<string>",
"html": "<string>",
"headers": {},
"attachments": [
{
"filename": "<string>",
"content": "<string>"
}
],
"scheduledAt": "2023-11-07T05:31:56Z",
"inReplyToId": "<string>"
}
]
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([
{
to: '<string>',
from: '<string>',
subject: '<string>',
templateId: '<string>',
variables: {},
replyTo: '<string>',
cc: '<string>',
bcc: '<string>',
text: '<string>',
html: '<string>',
headers: {},
attachments: [{filename: '<string>', content: '<string>'}],
scheduledAt: '2023-11-07T05:31:56Z',
inReplyToId: '<string>'
}
])
};
fetch('https://app.usesend.com/api/v1/emails/batch', 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://app.usesend.com/api/v1/emails/batch",
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([
[
'to' => '<string>',
'from' => '<string>',
'subject' => '<string>',
'templateId' => '<string>',
'variables' => [
],
'replyTo' => '<string>',
'cc' => '<string>',
'bcc' => '<string>',
'text' => '<string>',
'html' => '<string>',
'headers' => [
],
'attachments' => [
[
'filename' => '<string>',
'content' => '<string>'
]
],
'scheduledAt' => '2023-11-07T05:31:56Z',
'inReplyToId' => '<string>'
]
]),
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://app.usesend.com/api/v1/emails/batch"
payload := strings.NewReader("[\n {\n \"to\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"templateId\": \"<string>\",\n \"variables\": {},\n \"replyTo\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"headers\": {},\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"inReplyToId\": \"<string>\"\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://app.usesend.com/api/v1/emails/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"to\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"templateId\": \"<string>\",\n \"variables\": {},\n \"replyTo\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"headers\": {},\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"inReplyToId\": \"<string>\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.usesend.com/api/v1/emails/batch")
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 {\n \"to\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"templateId\": \"<string>\",\n \"variables\": {},\n \"replyTo\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"headers\": {},\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"inReplyToId\": \"<string>\"\n }\n]"
response = http.request(request)
puts response.read_body{
"data": [
{
"emailId": "<string>"
}
]
}