API reference
Unitpost exposes a versioned REST API at https://www.unitpost.com/api/v1. Authenticate every request with Authorization: Bearer pk_live_…. Requests are scoped to the workspace that owns the key and rate-limited per workspace. List endpoints are cursor-paginated and return a { object, has_more, data } envelope.
The full reference on one page lives at /docs. The machine-readable spec is at /api/v1/openapi.json.
Resources
- EmailsSend, schedule, retrieve, and cancel transactional email. Send one email or a batch of up to 100, track each message's delivery lifecycle, and pull aggregate deliverability stats for your workspace.
- Inbound emailsRead email your receiving-enabled domains have received — list messages, retrieve full bodies, and download attachments via short-lived signed URLs.
- ContactsManage the people you email. Create and update contacts one at a time or import thousands in the background, with standard and custom field values that templates can reference as variables.
- Contact fieldsDefine the typed custom attributes (text, number, date, …) your contacts carry — usable in templates as per-recipient variables.
- SegmentsNamed groups of contacts used to target campaigns. Segments decide who a campaign goes to; topics (below) decide what recipients can opt out of.
- TopicsSubscription categories (e.g. Promotions) recipients can opt out of without leaving your list, independent of segment membership. Scope a campaign to a topic and opted-out contacts are skipped automatically.
- CampaignsOne-to-many sends to a segment or an inline recipient list. Draft, validate, schedule, send, pause, resume, and cancel — with a pre-send report that catches problems before anything goes out.
- TemplatesReusable email designs in the canonical block-based JSON format the dashboard editor produces, with per-recipient `{{variables}}` filled at send time.
- Brand kitsRead-only Brand Kit profiles (voice, labeled colors, pinned library graphics, core pages) for on-brand template authoring. Writes and URL import stay in the dashboard (Settings → Brand).
- DomainsThe domains you send from. Add a domain, publish its DNS records, verify it, and manage its tracking and TLS defaults — sending is blocked until the domain verifies.
- WebhooksRegister HTTPS endpoints that receive signed event deliveries (delivered, bounced, opened, clicked, …). The signing secret is returned once on create; verify the signature on every delivery.
- API keysCreate and revoke the API keys your integrations authenticate with. These endpoints are session-gated (dashboard cookie + `apikeys:manage`) and NOT usable with a Bearer API key.
- SuppressionsAddress-level send blocks — the hard "never email this address" list. Combines engine-written bounce/complaint entries, your own additions, and read-only Unitpost-wide blocks.
- UsageYour workspace's current billing-period usage: emails sent, and on paid plans the dollar sending wallet (monthly allowance, spend, purchased credit, overage) in integer USD cents.