Features · API
One REST API for every workspace.
Create a key per workspace with exactly the permissions it needs. Manage contacts, lists, tags, segments, campaigns, templates, automations and forms, or send a single transactional email to a subscriber, all documented in OpenAPI.
01 · What you get
How api work in SendBeam.
- 01 Keys scoped to a workspace and a jobCreate keys under Settings → API keys (admins only). Each key carries the permissions you tick: contacts, tags, lists, campaigns, templates, automations, forms and segments, each as read or write. The full key (sb_live_…) is shown once, stored hashed, and revocable at any time. Send it in the x-api-key header.
- 02 Everything the dashboard doesContacts (create, update, tag, bulk actions, CSV import and export), lists with double opt-in membership, tags, segments with a rules preview that returns the match count and the reachable subscribed subset, campaigns (create, send or schedule, cancel, duplicate, preview the exact audience), templates, automations (activate, pause) and forms.
- 03 Transactional sendsPOST /api/v1/send emails one subscribed contact from the workspace’s sender identity, re-validated on every call. It refuses with 403 when the workspace is paused or the monthly quota is used, and with 429 plus a Retry-After header when the plan’s hourly ceiling is hit. Every send shows in Activity under the API filter with its delivery, open and click events.
- 04 Suppressions and importsQuery whether an address is suppressed and why, or import your old platform’s unsubscribes, bounces and complaints as JSON or CSV before your first import. Connect a Mailchimp, MailerLite or Kit API key to list what it can import and run the import through the same write path as the CSV importer, suppressions first.
- 05 Predictable errors, public specEvery error is a JSON object with a single error string and a conventional status: 400 validation, 401 auth, 403 permission or plan, 404 not this workspace’s, 409 conflict, 422 target must change first, 429 rate limited. The full reference lives at /docs/api and the OpenAPI 3 document at /openapi.json.
Plans. Reads, writes and sends work on every plan. What the plan sets is how many writes an hour: Free 120, Starter 600, Pro and Business unlimited. Reads are never counted, and API emails come out of the pooled monthly allowance like any other send. Compare plans.
02 · How it works
From zero to live.
The steps as they appear in the dashboard today. Each one is covered in more depth in the docs linked below.
- Step 01 Create a keySettings → API keys in the workspace you are integrating. Tick only the permissions the integration needs; make a separate key per site.
- Step 02 Read the specLoad /openapi.json into your client generator, or read /docs/api for examples per operation.
- Step 03 Call with x-api-keyBase URL https://sendbeam.io. JSON in, JSON out. Public endpoints (form submission, unsubscribe, confirm) take no key.
- Step 04 Send transactional emailCreate or look up the contact, then POST /api/v1/send. Handle 429 by waiting the Retry-After seconds.
- Step 05 Watch ActivityFilter by API to see each send’s delivery, open and click events alongside your campaigns.
03 · Questions
Asked before choosing api.
- Is one API key valid across all my workspaces?
- No. Keys are created inside a workspace and only see that workspace’s data, which is the point: a key on your client’s site cannot touch your own newsletter.
- Can I send to someone who is not a contact?
- Not through /api/v1/send: it mails one subscribed contact, so the unsubscribe and suppression rules apply to transactional mail too. Create the contact first (a suppressed address is refused with 409).
- Which plan do I need for the API?
- Every plan can read, write and send. The plan sets how many writes an hour — Free 120, Starter 600, Pro and Business unlimited — and reads are not counted at all.
- Is there an OpenAPI or Postman collection?
- The OpenAPI 3 document is served at /openapi.json and rendered at /docs/api. Import it into Postman, Insomnia or a code generator directly.
More features
- Sending guardrail A brake that stops one bad send becoming a dead domain.An automatic brake on a workspace whose mail has started going wrong — before a provider or a blocklist does it for you.
- Workspaces Run every site’s email from one account.One account for every site you run. A workspace per site, one plan for all of them.
- Forms Signup and contact forms that fit any site.Signup forms with double opt-in and contact forms that email you, both protected by Turnstile and an origin allow-list.
- Sending domains Every site sends from its own domain.A verified domain per site, DKIM and an aligned return path, and the CNAME records to publish.
- Automations Sequences that run themselves, per site.Trigger-based sequences per workspace: welcome series, lead magnets, tag-driven follow-ups.
04 · Start
Start with the site you run today.
Free to start, no card, no trial clock. Each site keeps its own domain, list and rules; you add the next one as a workspace whenever you launch it.
Checking system status