Send a message
curl --request POST \
--url https://email.{region}.basaltic.sh/v1/sent-messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identity": "<string>",
"from": "<string>",
"to": [
"<string>"
],
"content": {
"text": "<string>",
"html": "<string>",
"raw": "<string>",
"template": "<string>",
"template_data": {}
},
"attachments_bucket": "<string>",
"attachments": [
{
"bucket": "<string>",
"key": "<string>",
"name": "<string>",
"version_id": "<string>",
"content_type": "<string>"
}
],
"subject": "<string>",
"configuration_set": "<string>"
}
'import requests
url = "https://email.{region}.basaltic.sh/v1/sent-messages"
payload = {
"identity": "<string>",
"from": "<string>",
"to": ["<string>"],
"content": {
"text": "<string>",
"html": "<string>",
"raw": "<string>",
"template": "<string>",
"template_data": {}
},
"attachments_bucket": "<string>",
"attachments": [
{
"bucket": "<string>",
"key": "<string>",
"name": "<string>",
"version_id": "<string>",
"content_type": "<string>"
}
],
"subject": "<string>",
"configuration_set": "<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({
identity: '<string>',
from: '<string>',
to: ['<string>'],
content: {
text: '<string>',
html: '<string>',
raw: '<string>',
template: '<string>',
template_data: {}
},
attachments_bucket: '<string>',
attachments: [
{
bucket: '<string>',
key: '<string>',
name: '<string>',
version_id: '<string>',
content_type: '<string>'
}
],
subject: '<string>',
configuration_set: '<string>'
})
};
fetch('https://email.{region}.basaltic.sh/v1/sent-messages', 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://email.{region}.basaltic.sh/v1/sent-messages",
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([
'identity' => '<string>',
'from' => '<string>',
'to' => [
'<string>'
],
'content' => [
'text' => '<string>',
'html' => '<string>',
'raw' => '<string>',
'template' => '<string>',
'template_data' => [
]
],
'attachments_bucket' => '<string>',
'attachments' => [
[
'bucket' => '<string>',
'key' => '<string>',
'name' => '<string>',
'version_id' => '<string>',
'content_type' => '<string>'
]
],
'subject' => '<string>',
'configuration_set' => '<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://email.{region}.basaltic.sh/v1/sent-messages"
payload := strings.NewReader("{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<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("https://email.{region}.basaltic.sh/v1/sent-messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://email.{region}.basaltic.sh/v1/sent-messages")
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 \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"expires_at": "2023-11-07T05:31:56Z",
"attachments": [
{
"name": "<string>",
"content_type": "<string>",
"size": 123,
"bucket": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"key": "<string>",
"sha256": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_id": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "<string>",
"identity": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:email:sa-saopaulo-1:acme:identity/example.com",
"name": "example.com"
},
"from": "<string>",
"to": [
"<string>"
],
"status": "queued",
"queued_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"smtp_response": "<string>",
"error_message": "<string>",
"outbound_ip": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}Sent messages
Send a message
Accept a message using explicit text/HTML, raw MIME, or template content. A successful response means queued, not delivered. Organization quotas apply to MIME size and recipients. Template content also requires email:SendTemplatedMessage on the template. Use Idempotency-Key for safe retries.
POST
/
v1
/
sent-messages
Send a message
curl --request POST \
--url https://email.{region}.basaltic.sh/v1/sent-messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identity": "<string>",
"from": "<string>",
"to": [
"<string>"
],
"content": {
"text": "<string>",
"html": "<string>",
"raw": "<string>",
"template": "<string>",
"template_data": {}
},
"attachments_bucket": "<string>",
"attachments": [
{
"bucket": "<string>",
"key": "<string>",
"name": "<string>",
"version_id": "<string>",
"content_type": "<string>"
}
],
"subject": "<string>",
"configuration_set": "<string>"
}
'import requests
url = "https://email.{region}.basaltic.sh/v1/sent-messages"
payload = {
"identity": "<string>",
"from": "<string>",
"to": ["<string>"],
"content": {
"text": "<string>",
"html": "<string>",
"raw": "<string>",
"template": "<string>",
"template_data": {}
},
"attachments_bucket": "<string>",
"attachments": [
{
"bucket": "<string>",
"key": "<string>",
"name": "<string>",
"version_id": "<string>",
"content_type": "<string>"
}
],
"subject": "<string>",
"configuration_set": "<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({
identity: '<string>',
from: '<string>',
to: ['<string>'],
content: {
text: '<string>',
html: '<string>',
raw: '<string>',
template: '<string>',
template_data: {}
},
attachments_bucket: '<string>',
attachments: [
{
bucket: '<string>',
key: '<string>',
name: '<string>',
version_id: '<string>',
content_type: '<string>'
}
],
subject: '<string>',
configuration_set: '<string>'
})
};
fetch('https://email.{region}.basaltic.sh/v1/sent-messages', 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://email.{region}.basaltic.sh/v1/sent-messages",
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([
'identity' => '<string>',
'from' => '<string>',
'to' => [
'<string>'
],
'content' => [
'text' => '<string>',
'html' => '<string>',
'raw' => '<string>',
'template' => '<string>',
'template_data' => [
]
],
'attachments_bucket' => '<string>',
'attachments' => [
[
'bucket' => '<string>',
'key' => '<string>',
'name' => '<string>',
'version_id' => '<string>',
'content_type' => '<string>'
]
],
'subject' => '<string>',
'configuration_set' => '<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://email.{region}.basaltic.sh/v1/sent-messages"
payload := strings.NewReader("{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<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("https://email.{region}.basaltic.sh/v1/sent-messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://email.{region}.basaltic.sh/v1/sent-messages")
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 \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"expires_at": "2023-11-07T05:31:56Z",
"attachments": [
{
"name": "<string>",
"content_type": "<string>",
"size": 123,
"bucket": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"key": "<string>",
"sha256": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_id": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "<string>",
"identity": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:email:sa-saopaulo-1:acme:identity/example.com",
"name": "example.com"
},
"from": "<string>",
"to": [
"<string>"
],
"status": "queued",
"queued_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"smtp_response": "<string>",
"error_message": "<string>",
"outbound_ip": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}Requires the IAM action
email:SendMessage. See EMAIL permissions for the full list, what each one covers, and an example policy.Authorizations
An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>.
This is the recommended way to authenticate.
Get one by exchanging a service account's access key pair at
POST /v1/oauth/token with grant_type=client_credentials. It is the
standard client-credentials grant, so any OAuth-aware library will
obtain and refresh it for you.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.
Headers
Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.
Maximum string length:
255Body
application/json
UUID, CRN or account-unique name.
Minimum array length:
1Exactly one content mode: text and/or html; raw; or template with optional template_data. Text is never guessed to be HTML.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Bucket UUID, CRN or name for attachments embedded in raw MIME. Objects are written under email/{identity_id}/sent/{message_id}/. Separate attachments entries reference existing bucket objects.
Bucket objects to attach. GetObject permission is required; version and checksum are pinned at acceptance.
Show child attributes
Show child attributes
Subject for text/HTML content. For raw or template content, the subject is supplied by that content.
UUID, CRN or account-unique name.
Response
Message queued for delivery.
Show child attributes
Show child attributes