Getting started

Everything the InBuzzed dashboard can do, the API can do. This page walks through authentication and the conventions every endpoint shares.

Create an API key

Keys are created in Dashboard → API keys. Each key carries its own permission scopes — transactional, contacts, broadcasts, webhooks, and analytics — so a backend that only sends receipts never needs access to your audience.

Authenticate requests

Pass your key on every request — either in the X-Api-Key header or as a bearer token. Both are equivalent:

curl https://api.inbuzzed.com/api/v1/esp/lists \
  -H "X-Api-Key: ib_live_..."

A missing or malformed key returns 401. A valid key without the required permission scope returns 403.

Base URL

All API endpoints live under a single versioned base:

Base URL

https://api.inbuzzed.com/api/v1/esp

Paths in these docs are relative to that base — POST /transactional/send means POST https://api.inbuzzed.com/api/v1/esp/transactional/send.

The response envelope

Every successful response wraps its payload in the same envelope: a status of "success" and the result under data.

200 OK

{
  "status": "success",
  "data": {
    "…": "endpoint-specific payload"
  }
}

Errors

Errors return a 4xx or 5xx status code with a status of "fail" (client errors) or "error" (server errors) and a human-readable message:

{
  "status": "fail",
  "message": "'to' email address is required"
}

The status codes you will encounter:

Code	Meaning
`400`	Invalid request — the message names the missing or malformed field.
`401`	Missing, invalid, or revoked API key.
`403`	Key lacks the permission scope, or your plan doesn't include the feature.
`404`	Resource not found in your workspace.
`429`	Rate or send limit reached — see Rate limits & plans. Honor `retryAfter`.
`5xx`	Something failed on our side. Safe to retry with backoff.

SMTP relay

Tools that only speak SMTP can relay through InBuzzed using the same API key as both username and password:

SMTP

Host      smtp.inbuzzed.com
Ports     587 (STARTTLS), 2525, 8025
Username  ib_live_...   (your API key)
Password  ib_live_...   (the same key)

The from-address follows the same approved sender-domain policy as the API, and relayed mail counts toward the same plan limits.

Next steps

Send your first transactional email — the five-minute path to a delivered message.
Templates & variables — design in the studio, personalize over the API.
Rate limits & plans — how send windows and monthly volume work.