BlueyEmail API

Authentication

Every request needs an API key. Pass it as an X-API-Key header (recommended) or a Bearer token. Create keys in Settings → Integrations.

X-API-Key: YOUR_API_KEY

Authorization: Bearer YOUR_API_KEY

Test the connection

Confirm a key works with a single call to GET /api/v2/me. It needs no scope and returns the workspace plus the key’s auth context — ideal for a platform’s “Test connection” step.

curl -X GET "https://api.blueyemail.com/api/v2/me" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

{
  "success": true,
  "data": {
    "workspace": { "id": "uuid", "name": "Acme Inc" },
    "auth": { "method": "api_key", "mode": "live", "sandbox": false, "scopes": ["leads:write", "emails:send"] }
  }
}

Quick start

Send your first transactional email in one request.

curl -X POST "https://api.blueyemail.com/api/v2/transactional/send" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "you@example.com",
  "subject": "Hello from BlueyEmail",
  "html": "<h1>It works!</h1>"
}'

Sending over SMTP

BlueyEmail sends over HTTPS instead of SMTP. There is less to set up — no host, port, encryption mode or mail password — and it keeps working on hosting that blocks outbound SMTP ports, which is one of the most common reasons email quietly stops sending.

Here is how to connect, depending on what you are sending from:

Connecting something else, or a platform you would like us to support? Tell us what you are working with — it genuinely shapes what we build next.

Rate limits & sending volume

Two different limits apply, and it helps to keep them separate.

1 · API request rate

How many HTTP calls your workspace can make. Your allowance is set by your plan and is shared across every API key and OAuth token in the workspace — creating more keys does not raise it. Both a per-minute and a per-hour cap apply. Exceeding either returns 429 RATE_LIMITED. Every response carries your live budget in headers:

2 · Email sending volume

This is separate from the request rate. How many emails you can actually send is governed by a daily transactional ceiling (protects your sending reputation — raise it in Sending settings) and your monthly plan limit. Sends beyond a soft limit are queued, not dropped.

Errors

Errors return a nested error object with a type (derived from the HTTP status), a human-readable message, and a machine-readable code. The HTTP status is on the response itself. Some endpoints add extra fields (e.g. limit, reset_at, or the required scopes).

{
  "error": {
    "type": "auth_error",
    "message": "Invalid API key",
    "code": "INVALID_API_KEY"
  }
}