Reference
API Reference
SendBolt exposes a single versioned REST API at https://api.sendbolt.io/api/v1. Every endpoint is documented in the interactive OpenAPI (Swagger) spec. The spec is the source of truth — this page is a quick orientation.
Interactive API docs (Swagger UI)
Try any endpoint directly in the browser. You'll need a valid API key — grab one from Settings → API keys.
Open API docs →Base URL
https://api.sendbolt.io/api/v1
All endpoints are HTTPS-only. HTTP requests are redirected (301) to HTTPS.
Authentication
Pass your API key in the Authorization header as a Bearer token. See API keys & authentication for key scopes, rate limits, and rotation guidance.
curl "https://api.sendbolt.io/api/v1/whoami" \
-H "Authorization: Bearer $SENDBOLT_API_KEY"Key endpoint groups
| Group | Prefix | What it does |
|---|---|---|
| Transactional | /transactional/send | Single-recipient email (templates or raw HTML) |
| Campaigns | /campaigns | Create, schedule, and launch bulk campaigns |
| Contacts | /contacts | Contact CRUD + bulk import |
| Templates | /templates | Reusable HTML/text templates with variable slots |
| Suppressions | /suppressions | Read / write the per-tenant suppression list |
| Events | /events | Open, click, bounce, complaint event feed |
| Domains | /mail/domains | Sending domain verification + DKIM status |
| Inbound | /mail/mailboxes, /mail/messages | Workspace mailboxes + message API |
| Reputation | /reputation | Per-domain trust score + deliverability metrics |
Response format
All endpoints return JSON. Success responses use the envelope:
{
"ok": true,
"data": { ... } // present on success
}
// Error response
{
"ok": false,
"error": "invalid_scope",
"message": "The API key lacks the campaigns:write scope"
}Pagination
List endpoints use cursor-based pagination. Pass ?after=cursor_value&limit=50. The response includes a next_cursor field — when it is null you are on the last page.
Versioning
The current version is v1. Breaking changes will be released as /api/v2 with a 90-day deprecation notice for v1. Non-breaking additions (new fields, new endpoints) are made without version bumps.