Send emails
curl --request POST \
--url http://localhost:8080/email \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from_email": "[email protected]",
"recipients": [
{
"to_email": "[email protected]",
"email_body": "<string>",
"email_subject": "<string>",
"email_sender_name": "<string>",
"email_is_transactional": true
}
],
"delay_in_minutes": 123,
"fallback_email_subject": "<string>",
"fallback_email_sender_name": "<string>",
"fallback_email_body": "<string>"
}
'import requests
url = "http://localhost:8080/email"
payload = {
"from_email": "[email protected]",
"recipients": [
{
"to_email": "[email protected]",
"email_body": "<string>",
"email_subject": "<string>",
"email_sender_name": "<string>",
"email_is_transactional": True
}
],
"delay_in_minutes": 123,
"fallback_email_subject": "<string>",
"fallback_email_sender_name": "<string>",
"fallback_email_body": "<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({
from_email: '[email protected]',
recipients: [
{
to_email: '[email protected]',
email_body: '<string>',
email_subject: '<string>',
email_sender_name: '<string>',
email_is_transactional: true
}
],
delay_in_minutes: 123,
fallback_email_subject: '<string>',
fallback_email_sender_name: '<string>',
fallback_email_body: '<string>'
})
};
fetch('http://localhost:8080/email', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/email",
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([
'from_email' => '[email protected]',
'recipients' => [
[
'to_email' => '[email protected]',
'email_body' => '<string>',
'email_subject' => '<string>',
'email_sender_name' => '<string>',
'email_is_transactional' => true
]
],
'delay_in_minutes' => 123,
'fallback_email_subject' => '<string>',
'fallback_email_sender_name' => '<string>',
'fallback_email_body' => '<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 := "http://localhost:8080/email"
payload := strings.NewReader("{\n \"from_email\": \"[email protected]\",\n \"recipients\": [\n {\n \"to_email\": \"[email protected]\",\n \"email_body\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n ],\n \"delay_in_minutes\": 123,\n \"fallback_email_subject\": \"<string>\",\n \"fallback_email_sender_name\": \"<string>\",\n \"fallback_email_body\": \"<string>\"\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("http://localhost:8080/email")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from_email\": \"[email protected]\",\n \"recipients\": [\n {\n \"to_email\": \"[email protected]\",\n \"email_body\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n ],\n \"delay_in_minutes\": 123,\n \"fallback_email_subject\": \"<string>\",\n \"fallback_email_sender_name\": \"<string>\",\n \"fallback_email_body\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/email")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from_email\": \"[email protected]\",\n \"recipients\": [\n {\n \"to_email\": \"[email protected]\",\n \"email_body\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n ],\n \"delay_in_minutes\": 123,\n \"fallback_email_subject\": \"<string>\",\n \"fallback_email_sender_name\": \"<string>\",\n \"fallback_email_body\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 422,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}AI Email
Send emails
Send emails to multiple contacts, possibly with a time delay. Use when managing email-channel provisioning — domain verification, unsubscribe handling, outbound email injection.
POST
/
email
Send emails
curl --request POST \
--url http://localhost:8080/email \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from_email": "[email protected]",
"recipients": [
{
"to_email": "[email protected]",
"email_body": "<string>",
"email_subject": "<string>",
"email_sender_name": "<string>",
"email_is_transactional": true
}
],
"delay_in_minutes": 123,
"fallback_email_subject": "<string>",
"fallback_email_sender_name": "<string>",
"fallback_email_body": "<string>"
}
'import requests
url = "http://localhost:8080/email"
payload = {
"from_email": "[email protected]",
"recipients": [
{
"to_email": "[email protected]",
"email_body": "<string>",
"email_subject": "<string>",
"email_sender_name": "<string>",
"email_is_transactional": True
}
],
"delay_in_minutes": 123,
"fallback_email_subject": "<string>",
"fallback_email_sender_name": "<string>",
"fallback_email_body": "<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({
from_email: '[email protected]',
recipients: [
{
to_email: '[email protected]',
email_body: '<string>',
email_subject: '<string>',
email_sender_name: '<string>',
email_is_transactional: true
}
],
delay_in_minutes: 123,
fallback_email_subject: '<string>',
fallback_email_sender_name: '<string>',
fallback_email_body: '<string>'
})
};
fetch('http://localhost:8080/email', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/email",
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([
'from_email' => '[email protected]',
'recipients' => [
[
'to_email' => '[email protected]',
'email_body' => '<string>',
'email_subject' => '<string>',
'email_sender_name' => '<string>',
'email_is_transactional' => true
]
],
'delay_in_minutes' => 123,
'fallback_email_subject' => '<string>',
'fallback_email_sender_name' => '<string>',
'fallback_email_body' => '<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 := "http://localhost:8080/email"
payload := strings.NewReader("{\n \"from_email\": \"[email protected]\",\n \"recipients\": [\n {\n \"to_email\": \"[email protected]\",\n \"email_body\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n ],\n \"delay_in_minutes\": 123,\n \"fallback_email_subject\": \"<string>\",\n \"fallback_email_sender_name\": \"<string>\",\n \"fallback_email_body\": \"<string>\"\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("http://localhost:8080/email")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from_email\": \"[email protected]\",\n \"recipients\": [\n {\n \"to_email\": \"[email protected]\",\n \"email_body\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n ],\n \"delay_in_minutes\": 123,\n \"fallback_email_subject\": \"<string>\",\n \"fallback_email_sender_name\": \"<string>\",\n \"fallback_email_body\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/email")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from_email\": \"[email protected]\",\n \"recipients\": [\n {\n \"to_email\": \"[email protected]\",\n \"email_body\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_sender_name\": \"<string>\",\n \"email_is_transactional\": true\n }\n ],\n \"delay_in_minutes\": 123,\n \"fallback_email_subject\": \"<string>\",\n \"fallback_email_sender_name\": \"<string>\",\n \"fallback_email_body\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 422,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Every recipient is checked before anything is queued, transactional emails included. If any recipient restricted email or is on the outbound blocklist, the whole request is refused with HTTP
422 and nothing is sent; see refused sends. Send again without that recipient. A delayed email is checked again when it goes out and is not sent if the recipient was restricted or blocked in the meantime.Authorizations
Body
application/json
Was this page helpful?