Documentation/Send an email

Send an email

Send a transactional email through the selected regional project.

POST/emails

Headers

NameTypeDescription

Idempotency-Keystring

Body parameters

FieldTypeDescription

fromrequiredstring

Example: "Acme <hello@example.com>".

torequiredstring (email) | array

ccarray

bccarray

reply_toarray

subjectrequiredstring

htmlstring

textstring

unsubscribeboolean | null

Override the sending domain's managed RFC 8058 one-click unsubscribe default. True adds the required List-Unsubscribe headers, false disables them, and null or omission inherits the domain default. Enabling it requires exactly one recipient.

headersobject

tagsarray

tags[].namerequiredstring

tags[].valuerequiredstring

scheduled_atstring (date-time)

attachmentsarray

attachments[].filenamerequiredstring

attachments[].contentstring (byte)

attachments[].pathstring (uri)

attachments[].content_typestring

attachments[].content_idstring

templatestring | object

template.idrequiredstring

template.variablesobject

`200` response

Accepted resource ID

FieldTypeDescription

idrequiredstring

Example: "msg_01...".

`400` response

Error

FieldTypeDescription

namerequiredstring

messagerequiredstring

errorsobject

`403` response

Error

FieldTypeDescription

namerequiredstring

messagerequiredstring

errorsobject

`422` response

Error

FieldTypeDescription

namerequiredstring

messagerequiredstring

errorsobject

request.ts

typescript

curl --request POST 'https://api.au.boundry.dev/emails' \
+  -H 'Authorization: Bearer $BOUNDRY_API_KEY' \
+  -H 'Idempotency-Key: string' \
+  -H 'Content-Type: application/json' \
+  --data '{"from":"Acme <hello@example.com>","to":["customer@example.com"],"subject":"Your receipt","html":"<p>Thanks for your order.</p>"}'

import { Boundry } from "boundry-sdk";

const boundry = new Boundry({
  apiKey: process.env.BOUNDRY_API_KEY!,
});

const response = await boundry.emails.send({
  from: "Acme <hello@example.com>",
  to: [
    "customer@example.com"
  ],
  subject: "Your receipt",
  html: "<p>Thanks for your order.</p>"
});

from boundry import Boundry

boundry = Boundry(api_key="$BOUNDRY_API_KEY")
response = boundry.emails.send({
  "from": "Acme <hello@example.com>",
  "to": [
    "customer@example.com"
  ],
  "subject": "Your receipt",
  "html": "<p>Thanks for your order.</p>"
})

response.json200 response

application/json

{
  "id": "msg_01..."
}

Send an email

Headers

Body parameters

200 response

400 response

403 response

422 response

`200` response

`400` response

`403` response

`422` response