boundry.
RegionSydney, Australia
Documentation/quickstart

Send your first email

This is the shortest path from a new Boundry project to a real transactional email request. You will create a project key, set up a verified sender, and make one regional API call.

1

Create a project in your target region. A project is the data boundary for its domains, API keys, messages and event history.

2

Verify a sending domain. Your From address must belong to a verified domain in this exact project.

3

Create an API key and send. Keep the secret server-side; the first request returns an email ID you can inspect in the dashboard.

1. Create a project API key

In Dashboard → API keys, create a key for the project you are integrating. The raw token is shown once—copy it into your local environment rather than committing it to source control.

Terminal
bash
export BOUNDRY_API_KEY="<your API key>"

2. Use a verified sender

For a local demo, the preconfigured sender domain is available. For any real domain, publish its DNS records first and wait until the domain shows Verified in the dashboard. See verify a domain for the full flow.

3. Send an email

Choose your language, then make the request to the Sydney regional endpoint. You should receive an id; use it to view the message and lifecycle events in the project’s Emails page.

send.sh
Shell
curl -X POST https://api.au.boundry.dev/emails \
  -H "Authorization: Bearer $BOUNDRY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "Acme <hello@acme.com>",
    "to": ["ava@northwind.com.au"],
    "subject": "Welcome to Acme",
    "html": "<p>It works.</p>"
  }'

Local development

Start with https://api.au.boundry.dev. For local work, override baseUrl; this replaces the configured endpoint rather than becoming the endpoint you publish or deploy.

Local override
TypeScript
const boundry = new Boundry({
  apiKey: process.env.BOUNDRY_API_KEY,
  baseUrl: "http://localhost:3000/api/au",
});

4. Confirm delivery

Open Dashboard → Emails and select the message. Local mode queues and records it immediately. When you run with SES mode, the same API call records the provider message ID and delivery event in the selected region.

AU

Regional by default. The local endpoint emulates Sydney. In production, change credentials and endpoint—not your integration.

Read every send-email parameter