Email

A domain, then the first send. Every call is on this page.

Start

Verify a domain, then send the first email.

Email starts with a domain you own. Add it under Domains, publish the DNS records, and wait until it verifies. Live sends use a from address on that domain.

A template is optional. You can send HTML or text in the request, or save the message on Templates and pass its id. The Quickstart is the full first-send walkthrough, including the API key.

Domains — DNS and verification.
Templates — reusable HTML and variables.
Emails API — send, retrieve, and list.

Quickstart

Create a key, verify a domain, and send your first email.

Open this guide on its own page

You can send your first email in minutes: create an API key, verify a domain, and make a POST request.

1. Create an API key

Go to API Keys. Choose a preset — Full, Sending, or Read only — or narrow it further. Copy the key when shown.

Scope keys tightly

A server that only sends mail should use a Sending key. Keys can never manage other keys, team, or billing.

2. Verify a sending domain

Add your domain under Domains and publish the generated DNS records. Verification runs automatically.

No domain yet?

While DNS propagates you can still send test emails to your own address from the dashboard onboarding flow — no verified domain required. Test sends confirm the pipeline works; live API sends need a verified domain.

3. Send

Send an email in one call — a from address on your verified domain, a recipient, a subject, and either inline HTML or a template ID. The from accepts a bare address or a display name (`"Acme <you@yourdomain.com>"`).

cURL

curl https://www.unitpost.com/api/v1/email \
  -H "Authorization: Bearer $UNITPOST_API_KEY" \
  -H "Content-Type: application/json" \
  -H "User-Agent: my-app/1.0" \
  -d '{
    "from": "Acme <you@yourdomain.com>",
    "to": "customer@acme.com",
    "subject": "Welcome aboard",
    "html": "<p>Thanks for signing up!</p>"
  }'

The response includes the new email's id. Use GET /api/v1/email/{id} (or `unitpost.email.get(id)`) to read its current status and lifecycle events, or watch it live on the Emails page in the dashboard.

Templates & variables

Reference a saved template and pass per-recipient data.

Open this guide on its own page

Rather than inlining HTML on every send, save a template once and reference it by ID. Pass `template.variables` and any {{variable}} in the template is substituted at send time.

cURL

curl https://www.unitpost.com/api/v1/email \
  -H "Authorization: Bearer $UNITPOST_API_KEY" \
  -H "Content-Type: application/json" \
  -H "User-Agent: my-app/1.0" \
  -d '{
    "from": "you@yourdomain.com",
    "to": "customer@acme.com",
    "template": {
      "id": "tmpl_123",
       "variables": { "plan": "Pro" }
    }
  }'

When you send to a known contact, that contact's custom fields merge into the variables automatically — so a template can reference {{first_name}} without you re-sending it on every request.

Drafts can't be sent

A template must be published before the API will send it. Referencing a draft returns a 422 with code template_not_published. Publish it in the editor first.

Author templates in the visual editor, or in your app with `import { Heading, render } from "@unitpost/email/react"` and POST `{ name, html: render(<Email />), subject }`. Manage them under Templates. Every block and layout is documented at /components.

Sending domains

Add SPF, DKIM, and DMARC so mail sends from your domain.

Open this guide on its own page

To send from your own domain you publish a few DNS records so mailbox providers trust the mail is really from you. Add the domain under Domains and copy the generated records to your DNS provider.

DKIM — a TXT record that lets us cryptographically sign your mail.
MAIL FROM — a custom return-path subdomain for SPF alignment.
DMARC — a policy record that tells receivers what to do with unaligned mail.

Verification is continuous, not one-shot. A domain is Verified, Degraded, or Unverified, and we keep re-checking the records over time.

Degraded still sends

You can send from a Verified or Degraded domain. Degraded means some records drifted but mail still flows — fix the flagged records to return to Verified. You cannot send from an Unverified domain.

Open & click tracking

Control engagement tracking per send, template, or category.

Open this guide on its own page

With tracking on, we inject a 1×1 open pixel and rewrite links so opens and clicks land in the email's event timeline and feed the engagement rates on your dashboard.

How the default is resolved

Tracking is resolved per send in a clear order, most specific first:

An explicit tracking flag on the request wins.
Otherwise the referenced template's default applies.
Otherwise the category default applies.

Sending a receipt or password reset?

Set tracking to false to deliver a clean, untracked transactional message. Many providers and recipients prefer no pixel on sensitive mail.

Bounces, complaints & suppression

How bad addresses are handled and where to review them.

Open this guide on its own page

When an address hard bounces or complains, we add it to your suppression list. It's enforced on every send (single, batch, and campaign), including CC and BCC recipients.

Hard bounce — the address is invalid or rejected permanently; it's suppressed (reason: bounced).
Complaint — the recipient marked the mail as spam; it's suppressed (reason: complained).
Soft bounce — a temporary failure (full mailbox, greylisting); no suppression, and delivery is retried.

Suppressed recipients are excluded, not failed — surfaced as a "Recipients excluded" event on the timeline. Review the list on the Suppressions tab. You can remove an address there to make it mailable again — but re-sending to bad addresses hurts deliverability.

Suppression is separate from marketing unsubscribe

The suppression list is distinct from a contact's marketing preference. An address can be unsubscribed from marketing but mailable for transactional sends, or suppressed outright. Manage blocks on the Suppressions page; manage preferences on the contact.

Get these as webhooks

Every lifecycle event is available in-app today, and you can also have us POST them to your own endpoint in real time. See the Webhooks guide to register an endpoint and verify the signed payloads.

Emails

Send, 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.

List sent emails

GET/api/v1/email

GET /email

curl -X GET 'https://www.unitpost.com/api/v1/email' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "email",
      "id": "id_123",
      "to": [
        "customer@example.com"
      ],
      "from": "you@yourdomain.com",
      "subject": "Welcome to Acme",
      "template_id": "template_123",
      "campaign_id": "campaign_123",
      "status": "scheduled",
      "last_event": "string",
      "scheduled_at": "2026-01-01T00:00:00.000Z",
      "sent_at": "2026-01-01T00:00:00.000Z",
      "delivered_at": "2026-01-01T00:00:00.000Z",
      "opened_at": "2026-01-01T00:00:00.000Z",
      "clicked_at": "2026-01-01T00:00:00.000Z",
      "canceled_at": "2026-01-01T00:00:00.000Z",
      "last_error": "string",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve a list of emails your workspace has sent or scheduled. Results are newest-first and cursor-paginated, and each row is a reference to a single email (status and lifecycle timestamps, not the rendered body). Narrow the list with the status, campaign_id, batch_id, and created_after/created_before filters. Use an email's id with Retrieve an email to read its full record, or Cancel or reschedule an email to change a scheduled send. For aggregate deliverability numbers over a window, see Email deliverability stats. Requires the emails:read capability.

Parameters8 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).
`status`	string · query	Filter by send status.
`campaign_id`	string · query	Only emails produced by this campaign's fan-out.
`batch_id`	string · query	Only emails sent as part of this batch.
`created_after`	string · query	Only emails created at/after this ISO 8601 time.
`created_before`	string · query	Only emails created at/before this ISO 8601 time.

Response · 200 fields17 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`to`required	string[]	—
`from`required	string	—
`subject`required	string	—
`template_id`required	object	—
`campaign_id`required	object	—
`status`required	enumscheduled \| queued \| sent \| delivered \| bounced \| complained \| canceled \| failed	—
`last_event`required	string	—
`scheduled_at`required	object	—
`sent_at`required	object	—
`delivered_at`required	object	—
`opened_at`required	object	—
`clicked_at`required	object	—
`canceled_at`required	object	—
`last_error`required	object	—
`created_at`required	string	—

200401403422

Send or schedule an email

POST/api/v1/email

POST /email

curl -X POST 'https://www.unitpost.com/api/v1/email' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "from": "you@yourdomain.com",
    "to": "customer@example.com",
    "subject": "Welcome to Acme",
    "html": "<h1>Hello</h1>"
  }'

Response · 200

{
  "id": "id_123",
  "status": "queued",
  "scheduled_at": "2026-01-01T00:00:00.000Z"
}

Send a single transactional email — now, or at a future time by passing scheduled_at. Provide the content inline as html/text, or reference a saved template with template (create one with Create a template). Pass an Idempotency-Key header to make retries safe: the same key replays the original result instead of sending twice. The response returns the new email's id — read its delivery status back with Retrieve an email, change a scheduled send with Cancel or reschedule an email, or send many at once with Send a batch of emails. Requires the emails:send capability.

Request body16 fields

Field	Type	Description
`from`required	string	Sender address on one of your verified domains. Accepts a bare address ("hi@acme.com") or a display name ("Acme <hi@acme.com>") — the name is what inbox clients show next to the message.
`to`required	object	—
`subject`	string	—
`cc`	object	—
`bcc`	object	—
`reply_to`	object	—
`in_reply_to`	string	—
`headers`	object	—
`tags`	object[]	—
`template`	object	Published template plus variable values. Mutually exclusive with `html` and `text`.
`html`	string	HTML MIME body. It is sanitized for email safety and may be supplied with `text` to create a multipart alternative. This field does not parse Markdown.
`text`	string	Plain-text MIME body. Newline characters are preserved; Markdown and rich-text styling are not interpreted. It may be supplied with `html` as the fallback alternative. When `html` is sent without `text`, a plain-text alternative is derived from the visible HTML content; an explicit `text` value is always sent unchanged.
`attachments`	object[]	—
`open_tracking`	boolean	—
`click_tracking`	boolean	—
`scheduled_at`	string	—

Response · 200 fields3 fields

Field	Type	Description
`id`required	string	—
`status`required	enumqueued \| scheduled	—
`scheduled_at`required	string	—

200401403404409422429

Send a batch of emails

POST/api/v1/email/batch

POST /email/batch

curl -X POST 'https://www.unitpost.com/api/v1/email/batch' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "emails": [
      {
        "from": "you@yourdomain.com",
        "to": "a@example.com",
        "subject": "Hi A",
        "html": "<p>Hi A</p>"
      },
      {
        "from": "you@yourdomain.com",
        "to": "b@example.com",
        "subject": "Hi B",
        "html": "<p>Hi B</p>"
      }
    ]
  }'

Response · 200

{
  "object": "list",
  "batch_id": "batch_123",
  "status": "queued",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "data": [
    {
      "id": "id_123"
    }
  ],
  "failed": [
    {
      "index": 0,
      "error": "string"
    }
  ]
}

Send up to 100 transactional emails in a single request. Validation is all-or-nothing: if any item is invalid the whole batch is rejected and nothing is queued, so you never end up with a partial send. Pass an Idempotency-Key header to make retries safe — the same key replays the original result instead of re-sending. The response returns a batch_id; track the batch's per-status rollup with Retrieve a batch and stop the rest of it with Cancel a batch. To send one email, use Send or schedule an email. Requires the emails:send capability.

Response · 200 fields1 field

Field	Type	Description
`id`required	string	—

200401403409422429

Retrieve a batch

GET/api/v1/email/batches/{id}

GET /email/batches/{id}

curl -X GET 'https://www.unitpost.com/api/v1/email/batches/batch_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "batch",
  "id": "id_123",
  "count": 1,
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "status_counts": {},
  "cancelable": 0
}

Retrieve a batch and its live, per-status rollup (how many of its messages are queued, sent, delivered, bounced, and so on). The counts update as the batch progresses. Create a batch with Send a batch of emails, or stop its remaining messages with Cancel a batch. Requires the emails:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields7 fields

Field	Type	Description
`object`required	enumbatch	—
`id`required	string	—
`count`required	integer	—
`scheduled_at`required	string	—
`created_at`required	string	—
`status_counts`required	object	Live child counts keyed by status (e.g. { delivered: 98, failed: 2 }).
`cancelable`required	integer	—

200401403404

Cancel a batch

POST/api/v1/email/batches/{id}/cancel

POST /email/batches/{id}/cancel

curl -X POST 'https://www.unitpost.com/api/v1/email/batches/batch_123/cancel' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "batch",
  "id": "id_123",
  "count": 1,
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "status_counts": {},
  "cancelable": 0
}

Cancel every still-cancelable message in a batch in one call. Messages that have already been sent are left untouched — only queued or scheduled ones are stopped. Check what remains cancelable first with Retrieve a batch. Requires the emails:send capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields7 fields

Field	Type	Description
`object`required	enumbatch	—
`id`required	string	—
`count`required	integer	—
`scheduled_at`required	string	—
`created_at`required	string	—
`status_counts`required	object	Live child counts keyed by status (e.g. { delivered: 98, failed: 2 }).
`cancelable`required	integer	—

200401403404409

Retrieve an email

GET/api/v1/email/{id}

GET /email/{id}

curl -X GET 'https://www.unitpost.com/api/v1/email/email_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "email",
  "id": "id_123",
  "to": [
    "customer@example.com"
  ],
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "template_id": "template_123",
  "campaign_id": "campaign_123",
  "status": "scheduled",
  "last_event": "string",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "sent_at": "2026-01-01T00:00:00.000Z",
  "delivered_at": "2026-01-01T00:00:00.000Z",
  "opened_at": "2026-01-01T00:00:00.000Z",
  "clicked_at": "2026-01-01T00:00:00.000Z",
  "canceled_at": "2026-01-01T00:00:00.000Z",
  "last_error": "string",
  "created_at": "2026-01-01T00:00:00.000Z"
}

Retrieve a single email by id, including its current send status and lifecycle timestamps (created, scheduled, sent, delivered, and so on). Find an id by browsing List sent emails. Messages submitted over **SMTP** can also be retrieved by the RFC 5322 Message-ID your mail library stamped on them (URL-encode it, e.g. /email/%3Cabc%40example.com%3E; angle brackets optional) — the id in the SMTP 250 Queued as … reply works too. To change a scheduled or queued email, use Cancel or reschedule an email. Requires the emails:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields17 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`to`required	string[]	—
`from`required	string	—
`subject`required	string	—
`template_id`required	object	—
`campaign_id`required	object	—
`status`required	enumscheduled \| queued \| sent \| delivered \| bounced \| complained \| canceled \| failed	—
`last_event`required	string	—
`scheduled_at`required	object	—
`sent_at`required	object	—
`delivered_at`required	object	—
`opened_at`required	object	—
`clicked_at`required	object	—
`canceled_at`required	object	—
`last_error`required	object	—
`created_at`required	string	—

200401403404

Cancel or reschedule an email

PATCH/api/v1/email/{id}

PATCH /email/{id}

curl -X PATCH 'https://www.unitpost.com/api/v1/email/email_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "scheduled_at": null
  }'

Response · 200

{
  "object": "email",
  "id": "id_123",
  "to": [
    "customer@example.com"
  ],
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "template_id": "template_123",
  "campaign_id": "campaign_123",
  "status": "scheduled",
  "last_event": "string",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "sent_at": "2026-01-01T00:00:00.000Z",
  "delivered_at": "2026-01-01T00:00:00.000Z",
  "opened_at": "2026-01-01T00:00:00.000Z",
  "clicked_at": "2026-01-01T00:00:00.000Z",
  "canceled_at": "2026-01-01T00:00:00.000Z",
  "last_error": "string",
  "created_at": "2026-01-01T00:00:00.000Z"
}

Cancel a scheduled or queued email, or move it to a new send time. Only emails that haven't been handed off for delivery yet can be changed — once an email is sent this returns 409. Look up the email's current state first with Retrieve an email. Requires the emails:send capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body2 fields

Field	Type	Description
`cancel`	boolean	—
`scheduled_at`	string	—

Response · 200 fields17 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`to`required	string[]	—
`from`required	string	—
`subject`required	string	—
`template_id`required	object	—
`campaign_id`required	object	—
`status`required	enumscheduled \| queued \| sent \| delivered \| bounced \| complained \| canceled \| failed	—
`last_event`required	string	—
`scheduled_at`required	object	—
`sent_at`required	object	—
`delivered_at`required	object	—
`opened_at`required	object	—
`clicked_at`required	object	—
`canceled_at`required	object	—
`last_error`required	object	—
`created_at`required	string	—

200401403404409422

Email deliverability stats

GET/api/v1/email/stats

GET /email/stats

curl -X GET 'https://www.unitpost.com/api/v1/email/stats' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "windowDays": 0,
  "clampedToRetentionDays": 0,
  "totals": {
    "sent": 0,
    "delivered": 0,
    "opened": 0,
    "clicked": 0,
    "bounced": 0,
    "complained": 0,
    "failed": 0
  },
  "rates": {
    "delivery": 0,
    "open": 0,
    "click": 0,
    "bounce": 0,
    "complaint": 0
  }
}

Retrieve aggregate deliverability and engagement metrics for your workspace over a rolling window. You get totals (sent, delivered, opened, clicked, bounced, complained, failed) alongside the rates that matter — delivery, open, click, bounce, and complaint. Open and click rates count only emails where that tracking was enabled, so turning tracking off for transactional mail won't skew them. Control the window with the days parameter (1–365, default 30). For the individual emails behind these numbers, see List sent emails. Requires the emails:read capability.

Parameters1 field

Field	Type	Description
`days`	integer · query	Window size in days (1–365). Defaults to 30; values above 365 are rejected.

Response · 200 fields4 fields

Field	Type	Description
`windowDays`required	integer	The rolling window, in days.
`clampedToRetentionDays`	integer	Non-null when the requested window exceeded the plan's log retention and was clamped to this many days (data past the retention horizon is purged).
`totals`required	object	—
`rates`required	object	Percentages (one decimal). delivery/bounce/complaint are vs sent; open/click are vs delivered.

200401403422

Inbound emails

Read email your receiving-enabled domains have received — list messages, retrieve full bodies, and download attachments via short-lived signed URLs.

List received emails

GET/api/v1/email/received

GET /email/received

curl -X GET 'https://www.unitpost.com/api/v1/email/received' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "received_email",
      "id": "id_123",
      "from": "you@yourdomain.com",
      "from_name": "string",
      "to": [
        "customer@example.com"
      ],
      "cc": [
        "string"
      ],
      "bcc": [
        "string"
      ],
      "message_id": "message_123",
      "subject": "Welcome to Acme",
      "spam_verdict": "string",
      "virus_verdict": "string",
      "spf_verdict": "string",
      "dkim_verdict": "string",
      "dmarc_verdict": "string",
      "size": 1,
      "received_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "attachment_count": 1
    }
  ]
}

Retrieve a list of inbound emails received on your receiving-enabled domains, newest-first and cursor-paginated. Rows are summaries (sender, subject, timestamps) without bodies — use a message's id with Retrieve a received email to read the full content and attachment metadata. Requires the emails:read capability.

Parameters3 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

Response · 200 fields18 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`from`required	string	—
`from_name`required	object	—
`to`required	string[]	—
`cc`required	string[]	—
`bcc`required	string[]	—
`message_id`required	object	—
`subject`required	object	—
`spam_verdict`required	object	—
`virus_verdict`required	object	—
`spf_verdict`required	object	—
`dkim_verdict`required	object	—
`dmarc_verdict`required	object	—
`size`required	number	—
`received_at`required	string	—
`created_at`required	string	—
`attachment_count`required	number	—

200401403422

Retrieve a received email

GET/api/v1/email/received/{id}

GET /email/received/{id}

curl -X GET 'https://www.unitpost.com/api/v1/email/received/email_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "received_email",
  "id": "id_123",
  "from": "you@yourdomain.com",
  "from_name": "string",
  "to": [
    "customer@example.com"
  ],
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "message_id": "message_123",
  "subject": "Welcome to Acme",
  "text": "string",
  "html": "string",
  "spam_verdict": "string",
  "virus_verdict": "string",
  "spf_verdict": "string",
  "dkim_verdict": "string",
  "dmarc_verdict": "string",
  "size": 1,
  "attachments": [
    {
      "object": "received_attachment",
      "id": "id_123",
      "filename": "string",
      "content_type": "string",
      "content_disposition": "string",
      "content_id": "content_123",
      "size": 1
    }
  ],
  "received_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z"
}

Retrieve a full inbound message by id, including its HTML and text bodies plus metadata for every attachment. Attachment bytes aren't inlined — download each one via Get an attachment download URL. Browse your inbound mail with List received emails. Requires the emails:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`from`required	string	—
`from_name`required	object	—
`to`required	string[]	—
`cc`required	string[]	—
`bcc`required	string[]	—
`message_id`required	object	—
`subject`required	object	—
`text`required	object	—
`html`required	object	—
`spam_verdict`required	object	—
`virus_verdict`required	object	—
`spf_verdict`required	object	—
`dkim_verdict`required	object	—
`dmarc_verdict`required	object	—
`size`required	number	—
`attachments`required	object[]	—
`received_at`required	string	—
`created_at`required	string	—

200401403404

Get an attachment download URL

GET/api/v1/email/received/{id}/attachments/{attachmentId}

GET /email/received/{id}/attachments/{attachmentId}

curl -X GET 'https://www.unitpost.com/api/v1/email/received/email_123/attachments/att_789' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "received_attachment_url",
  "url": "https://example.com",
  "expires_at": "2026-01-01T00:00:00.000Z"
}

Get a short-lived, signed URL for downloading one inbound attachment's bytes. Fetch the URL and download promptly — it expires quickly (the expiry is included in the response). Find attachment ids on the message via Retrieve a received email. Requires the emails:read capability.

Parameters2 fields

Field	Type	Description
`id`required	string · path	—
`attachmentId`required	string · path	—

Response · 200 fields3 fields

Field	Type	Description
`object`required	enumreceived_attachment_url	—
`url`required	string	A signed, expiring URL to download the attachment bytes.
`expires_at`required	string	ISO 8601 expiry of the signed URL (~5 minutes out).

200401403404503

Topics

Subscription 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.

List topics

GET/api/v1/email/topics

GET /email/topics

curl -X GET 'https://www.unitpost.com/api/v1/email/topics' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "topic",
      "id": "id_123",
      "name": "Example",
      "description": "string",
      "default_opt_in": false,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve a list of your subscription topics, cursor-paginated. A topic is a category of email (e.g. Product updates, Promotions) that recipients can opt out of without leaving your list entirely. Pass ?archived=true to list archived topics instead. Create one with Create a topic, or check a contact's preferences with List a contact's topic subscriptions. Requires the topics:read capability.

Parameters3 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

Response · 200 fields7 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`description`required	object	—
`default_opt_in`required	boolean	—
`created_at`required	string	—
`updated_at`required	string	—

200401422

Create a topic

POST/api/v1/email/topics

POST /email/topics

curl -X POST 'https://www.unitpost.com/api/v1/email/topics' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Product updates",
    "default_opt_in": true
  }'

Response · 201

{
  "object": "topic",
  "id": "id_123",
  "name": "Example",
  "description": "string",
  "default_opt_in": false,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Create a subscription topic — a category recipients can opt out of on their own (e.g. Promotions) while staying on your list. default_opt_in decides whether contacts with no explicit preference are treated as subscribed. Scope a campaign to a topic so opted-out contacts are skipped automatically via Create a campaign, and set an individual contact's preference with Set a contact's topic preference. Topics differ from segments: a segment decides who a campaign targets, a topic lets recipients opt out. Requires the topics:write capability.

Request body3 fields

Field	Type	Description
`name`required	string	—
`description`	string	—
`default_opt_in`	boolean	—

Response · 201 fields7 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`description`required	object	—
`default_opt_in`required	boolean	—
`created_at`required	string	—
`updated_at`required	string	—

201401409422

Retrieve a topic

GET/api/v1/email/topics/{id}

GET /email/topics/{id}

curl -X GET 'https://www.unitpost.com/api/v1/email/topics/top_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "topic",
  "id": "id_123",
  "name": "Example",
  "description": "string",
  "default_opt_in": false,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve a single topic by id, including its name and default_opt_in setting. Change it with Update a topic, or list every topic with List topics. Requires the topics:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields7 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`description`required	object	—
`default_opt_in`required	boolean	—
`created_at`required	string	—
`updated_at`required	string	—

200401404

Update a topic

PATCH/api/v1/email/topics/{id}

PATCH /email/topics/{id}

curl -X PATCH 'https://www.unitpost.com/api/v1/email/topics/top_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'

Response · 200

{
  "object": "topic",
  "id": "id_123",
  "name": "Example",
  "description": "string",
  "default_opt_in": false,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update a topic's name or default_opt_in behavior, or pass { "archived": true | false } to archive or restore it. Archiving a topic hides it and stops it from being targeted, but is blocked with 409 while an active campaign still targets it. To manage a single contact's preference, use Set a contact's topic preference. Requires the topics:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body3 fields

Field	Type	Description
`name`	string	—
`description`	object	—
`default_opt_in`	boolean	—

Response · 200 fields7 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`description`required	object	—
`default_opt_in`required	boolean	—
`created_at`required	string	—
`updated_at`required	string	—

200401404409422

Delete a topic

DELETE/api/v1/email/topics/{id}

DELETE /email/topics/{id}

curl -X DELETE 'https://www.unitpost.com/api/v1/email/topics/top_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Archive a topic (a soft delete — existing subscription records are preserved so you can restore it later). It's blocked with 409 while an active campaign still targets it. Restore an archived topic by sending { "archived": false } to Update a topic. Requires the topics:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

204401404409

List a contact's topic subscriptions

GET/api/v1/contacts/{id}/topics

GET /contacts/{id}/topics

curl -X GET 'https://www.unitpost.com/api/v1/contacts/con_123/topics' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "contact_topic",
      "topic_id": "topic_123",
      "subscribed": false,
      "status": "subscribed",
      "source": "user"
    }
  ]
}

Retrieve a contact's effective subscription state for every active topic, cursor-paginated. Each row resolves the contact's explicit preference against the topic's default_opt_in, so subscribed is always the answer to "would this contact receive a campaign scoped to this topic?". Change a preference with Set a contact's topic preference. Requires the topics:read capability.

Parameters4 fields

Field	Type	Description
`id`required	string · path	—
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

Response · 200 fields5 fields

Field	Type	Description
`object`required	string	—
`topic_id`required	string	—
`subscribed`required	boolean	—
`status`required	enumsubscribed \| unsubscribed	—
`source`required	enumuser \| manual \| import \| api	—

200401404422

Set a contact's topic preference

POST/api/v1/contacts/{id}/topics

POST /contacts/{id}/topics

curl -X POST 'https://www.unitpost.com/api/v1/contacts/con_123/topics' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "topic_id": "top_123",
    "subscribed": false
  }'

Response · 201

{
  "object": "contact_topic",
  "topic_id": "topic_123",
  "subscribed": false,
  "status": "subscribed",
  "source": "user"
}

Subscribe or unsubscribe a contact for one topic. This records an explicit preference that overrides the topic's default_opt_in, and it's idempotent — setting the same preference twice succeeds. PUT behaves identically. Read the contact's current state with List a contact's topic subscriptions. Requires the topics:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body3 fields

Field	Type	Description
`topic_id`	string	—
`topic`	string	—
`subscribed`required	boolean	—

Response · 201 fields5 fields

Field	Type	Description
`object`required	string	—
`topic_id`required	string	—
`subscribed`required	boolean	—
`status`required	enumsubscribed \| unsubscribed	—
`source`required	enumuser \| manual \| import \| api	—

201401404422

Set a contact's topic preference (alias of POST)

PUT/api/v1/contacts/{id}/topics

PUT /contacts/{id}/topics

curl -X PUT 'https://www.unitpost.com/api/v1/contacts/con_123/topics' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "topic_id": "top_123",
    "subscribed": false
  }'

Response · 201

{
  "object": "contact_topic",
  "topic_id": "topic_123",
  "subscribed": false,
  "status": "subscribed",
  "source": "user"
}

Identical to Set a contact's topic preference — provided so clients that prefer PUT semantics for an upsert can use it interchangeably. Requires the topics:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body3 fields

Field	Type	Description
`topic_id`	string	—
`topic`	string	—
`subscribed`required	boolean	—

Response · 201 fields5 fields

Field	Type	Description
`object`required	string	—
`topic_id`required	string	—
`subscribed`required	boolean	—
`status`required	enumsubscribed \| unsubscribed	—
`source`required	enumuser \| manual \| import \| api	—

201401404422

Campaigns

One-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.

List campaigns

GET/api/v1/email/campaigns

GET /email/campaigns

curl -X GET 'https://www.unitpost.com/api/v1/email/campaigns' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "campaign",
      "id": "id_123",
      "name": "Example",
      "template_id": "template_123",
      "segment_id": "segment_123",
      "topic_id": "topic_123",
      "from": "you@yourdomain.com",
      "subject": "Welcome to Acme",
      "preview_text": "string",
      "open_tracking": false,
      "click_tracking": false,
      "status": "draft",
      "scheduled_at": "2026-01-01T00:00:00.000Z",
      "variable_fallbacks": {},
      "excluded_contact_ids": [
        "string"
      ],
      "total_recipients": 1,
      "sent_count": 1,
      "failed_count": 1,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve a list of your campaigns, cursor-paginated. Each row is a reference to one campaign and its current status (draft, scheduled, sending, sent, …). Use a campaign's id with Retrieve a campaign for the full record, or with List sent emails (?campaign_id=) to see the individual emails it produced. Requires the campaigns:read capability.

Parameters3 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401422

Create a campaign

POST/api/v1/email/campaigns

POST /email/campaigns

curl -X POST 'https://www.unitpost.com/api/v1/email/campaigns' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "June newsletter",
    "subject": "What's new",
    "from": "you@yourdomain.com",
    "template_id": "tmpl_123",
    "segment_id": "seg_123"
  }'

Response · 201

{
  "object": "campaign",
  "id": "id_123",
  "name": "Example",
  "template_id": "template_123",
  "segment_id": "segment_123",
  "topic_id": "topic_123",
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "preview_text": "string",
  "open_tracking": false,
  "click_tracking": false,
  "status": "draft",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "variable_fallbacks": {},
  "excluded_contact_ids": [
    "string"
  ],
  "total_recipients": 1,
  "sent_count": 1,
  "failed_count": 1,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Create a campaign in draft. Target either a saved segment (segment_id, see Create a segment) or an inline recipients list, and optionally scope it to a subscription topic (topic_id) so contacts who opted out of that topic are skipped automatically. Content comes from a published template_id (campaigns have no inline html/text). Nothing is sent yet — edit the draft with Update a campaign, check it with Validate a campaign, then launch it with Send a campaign. Requires the campaigns:write capability.

Request body13 fields

Field	Type	Description
`name`required	string	—
`template_id`required	string	—
`segment_id`	string	—
`recipients`	string[]	—
`topic_id`	string	—
`from`required	string	—
`subject`	string	—
`preview_text`	string	—
`scheduled_at`	string	—
`open_tracking`	object	—
`click_tracking`	object	—
`variable_fallbacks`	object	—
`excluded_contact_ids`	string[]	—

Response · 201 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

201401422

Retrieve a campaign

GET/api/v1/email/campaigns/{id}

GET /email/campaigns/{id}

curl -X GET 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "campaign",
  "id": "id_123",
  "name": "Example",
  "template_id": "template_123",
  "segment_id": "segment_123",
  "topic_id": "topic_123",
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "preview_text": "string",
  "open_tracking": false,
  "click_tracking": false,
  "status": "draft",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "variable_fallbacks": {},
  "excluded_contact_ids": [
    "string"
  ],
  "total_recipients": 1,
  "sent_count": 1,
  "failed_count": 1,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve a single campaign by id, including its status, targeting, content references, and schedule. To see the individual emails a sent campaign produced, filter List sent emails by campaign_id; for a pre-send readiness report, use Validate a campaign. Requires the campaigns:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401404

Update a campaign

PATCH/api/v1/email/campaigns/{id}

PATCH /email/campaigns/{id}

curl -X PATCH 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'

Response · 200

{
  "object": "campaign",
  "id": "id_123",
  "name": "Example",
  "template_id": "template_123",
  "segment_id": "segment_123",
  "topic_id": "topic_123",
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "preview_text": "string",
  "open_tracking": false,
  "click_tracking": false,
  "status": "draft",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "variable_fallbacks": {},
  "excluded_contact_ids": [
    "string"
  ],
  "total_recipients": 1,
  "sent_count": 1,
  "failed_count": 1,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Edit a campaign while it's still in draft (content edits after that return 409). Beyond content and targeting, you can: send archived to archive/restore it; set variable_fallbacks (fill-only per-variable defaults) and/or excluded_contact_ids to resolve a send blocked by missing variables — the API equivalent of the dashboard's pre-send fix; set topic_id to scope it to a subscription topic (or null to clear); and set open_tracking/click_tracking (tri-state; null inherits the template/domain default). See what's blocking a send with Validate a campaign. Requires the campaigns:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body6 fields

Field	Type	Description
`archived`	boolean	—
`topic_id`	object	—
`open_tracking`	object	—
`click_tracking`	object	—
`variable_fallbacks`	object	—
`excluded_contact_ids`	string[]	—

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401404409422

Delete a campaign

DELETE/api/v1/email/campaigns/{id}

DELETE /email/campaigns/{id}

curl -X DELETE 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Permanently delete a campaign that's in draft or a terminal state (sent, canceled, failed). A campaign that's mid-flight can't be deleted — stop it first with Cancel a campaign. Requires the campaigns:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

204401404409

Send a campaign

POST/api/v1/email/campaigns/{id}/send

POST /email/campaigns/{id}/send

curl -X POST 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123/send' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "campaign",
  "id": "id_123",
  "name": "Example",
  "template_id": "template_123",
  "segment_id": "segment_123",
  "topic_id": "topic_123",
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "preview_text": "string",
  "open_tracking": false,
  "click_tracking": false,
  "status": "draft",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "variable_fallbacks": {},
  "excluded_contact_ids": [
    "string"
  ],
  "total_recipients": 1,
  "sent_count": 1,
  "failed_count": 1,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Validate a campaign and then send it — immediately, or at its scheduled_at if one is set. If anything blocks the send (unverified domain, missing template variables, empty audience, …) you get a 409 with each blocking reason itemized in error.details[]. To see the full pre-send report without attempting a send, use Validate a campaign; fix variable issues via Update a campaign. A launched campaign can be paused or canceled. Requires the campaigns:send capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401404409

Cancel a campaign

POST/api/v1/email/campaigns/{id}/cancel

POST /email/campaigns/{id}/cancel

curl -X POST 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123/cancel' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "campaign",
  "id": "id_123",
  "name": "Example",
  "template_id": "template_123",
  "segment_id": "segment_123",
  "topic_id": "topic_123",
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "preview_text": "string",
  "open_tracking": false,
  "click_tracking": false,
  "status": "draft",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "variable_fallbacks": {},
  "excluded_contact_ids": [
    "string"
  ],
  "total_recipients": 1,
  "sent_count": 1,
  "failed_count": 1,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Cancel a draft, scheduled, or sending campaign. Cancelation is terminal — the campaign can't be restarted afterwards. Messages already sent to recipients are not recalled. If you only want to stop temporarily, use Pause a campaign instead. Requires the campaigns:send capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401404409

Pause a campaign

POST/api/v1/email/campaigns/{id}/pause

POST /email/campaigns/{id}/pause

curl -X POST 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123/pause' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "campaign",
  "id": "id_123",
  "name": "Example",
  "template_id": "template_123",
  "segment_id": "segment_123",
  "topic_id": "topic_123",
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "preview_text": "string",
  "open_tracking": false,
  "click_tracking": false,
  "status": "draft",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "variable_fallbacks": {},
  "excluded_contact_ids": [
    "string"
  ],
  "total_recipients": 1,
  "sent_count": 1,
  "failed_count": 1,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Pause a scheduled or sending campaign. A paused send stops cleanly between recipients — already-sent messages are untouched, and no partial email is ever produced. Continue where it left off with Resume a campaign, or stop it for good with Cancel a campaign. Requires the campaigns:send capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401404409

Resume a campaign

POST/api/v1/email/campaigns/{id}/resume

POST /email/campaigns/{id}/resume

curl -X POST 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123/resume' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "campaign",
  "id": "id_123",
  "name": "Example",
  "template_id": "template_123",
  "segment_id": "segment_123",
  "topic_id": "topic_123",
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "preview_text": "string",
  "open_tracking": false,
  "click_tracking": false,
  "status": "draft",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "variable_fallbacks": {},
  "excluded_contact_ids": [
    "string"
  ],
  "total_recipients": 1,
  "sent_count": 1,
  "failed_count": 1,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Resume a paused campaign. Sending continues with the recipients that hadn't been reached yet; anyone already delivered to is skipped idempotently, so nobody receives the campaign twice. Pause a send with Pause a campaign. Requires the campaigns:send capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401404409

Reschedule a campaign

POST/api/v1/email/campaigns/{id}/reschedule

POST /email/campaigns/{id}/reschedule

curl -X POST 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123/reschedule' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "scheduled_at": "2026-07-01T15:00:00Z"
  }'

Response · 200

{
  "object": "campaign",
  "id": "id_123",
  "name": "Example",
  "template_id": "template_123",
  "segment_id": "segment_123",
  "topic_id": "topic_123",
  "from": "you@yourdomain.com",
  "subject": "Welcome to Acme",
  "preview_text": "string",
  "open_tracking": false,
  "click_tracking": false,
  "status": "draft",
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "variable_fallbacks": {},
  "excluded_contact_ids": [
    "string"
  ],
  "total_recipients": 1,
  "sent_count": 1,
  "failed_count": 1,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Move a scheduled campaign to a new send time. Only campaigns that haven't started sending can be rescheduled — once a send is in flight, pause or cancel it instead. Requires the campaigns:send capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body1 field

Field	Type	Description
`scheduled_at`required	string	New send time, ISO 8601. Only SCHEDULED campaigns can be moved.

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401404409422

Validate a campaign

GET/api/v1/email/campaigns/{id}/validate

GET /email/campaigns/{id}/validate

curl -X GET 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123/validate' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "campaign_validation",
  "total_members": 1,
  "sendable": 0,
  "suppressed": 0,
  "excluded": 0,
  "missing_data": [
    {
      "contact_id": "contact_123",
      "email": "customer@example.com",
      "missing": [
        "string"
      ]
    }
  ],
  "unresolved_variables": [
    "string"
  ],
  "can_send": false
}

Run a non-mutating pre-send check and get the full readiness report: how many contacts will receive the campaign, how many are suppressed or excluded, which contacts are missing template variables, and a final can_send verdict. Nothing is sent or changed. Fix reported variable gaps with Update a campaign (variable_fallbacks / excluded_contact_ids), then launch with Send a campaign. Requires the campaigns:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields8 fields

Field	Type	Description
`object`required	enumcampaign_validation	—
`total_members`required	integer	—
`sendable`required	integer	—
`suppressed`required	integer	—
`excluded`required	integer	—
`missing_data`required	object[]	—
`unresolved_variables`required	string[]	—
`can_send`required	boolean	—

200401404

Templates

Reusable email HTML with per-recipient {{variables}} filled at send time. The dashboard visual editor is a separate surface and still uses the structured document internally.

List templates

GET/api/v1/email/templates

GET /email/templates

curl -X GET 'https://www.unitpost.com/api/v1/email/templates' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "template",
      "id": "id_123",
      "name": "Example",
      "subject": "Welcome to Acme",
      "status": "draft",
      "html": "string",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve a list of your email templates, cursor-paginated. List rows omit html to keep responses small — fetch a single template with Retrieve a template to get it. Reference a template's id when sending with Send or schedule an email or when creating a campaign. Requires the templates:read capability.

Parameters3 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

Response · 200 fields8 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`subject`required	object	—
`status`required	enumdraft \| published	—
`html`	object	—
`created_at`required	string	—
`updated_at`required	string	—

200401422

Create a template

POST/api/v1/email/templates

POST /email/templates

curl -X POST 'https://www.unitpost.com/api/v1/email/templates' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Welcome",
    "subject": "Welcome!",
    "html": "<h1>Hi Mike</h1>"
  }'

Response · 201

{
  "object": "template",
  "id": "id_123",
  "name": "Example",
  "subject": "Welcome to Acme",
  "status": "draft",
  "html": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Create a reusable email template from html (and optional subject). {{variables}} in the HTML fill per-recipient at send time. The body is stored in code mode so you can open it in the dashboard. Once created, send with it via Send or schedule an email, and iterate with Update a template. Requires the templates:write capability.

Request body5 fields

Field	Type	Description
`name`required	string	—
`subject`	string	—
`html`	string	The email body as HTML (compose with @unitpost/email `render()` or any HTML; `{{variables}}` fill at send). Pass exactly one of `html` or `text`.
`text`	string	Simple email body instead of `html` — plain text exactly as you'd type it into Gmail: lines, a blank line between paragraphs, '- ' or '1. ' list items, and inline <b>, <i>, <u>, <a href="…"> for emphasis and links. No Markdown (it stays literal). Sent as a bare mail-client fragment with no layout or colours; marketing templates get a one-line unsubscribe footer at send time. Max 20,000 characters. Pass exactly one of `html` or `text`.
`category`	enumtransactional \| marketing	—

Response · 201 fields8 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`subject`required	object	—
`status`required	enumdraft \| published	—
`html`	object	—
`created_at`required	string	—
`updated_at`required	string	—

201401422

Retrieve a template

GET/api/v1/email/templates/{id}

GET /email/templates/{id}

curl -X GET 'https://www.unitpost.com/api/v1/email/templates/tmpl_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "template",
  "id": "id_123",
  "name": "Example",
  "subject": "Welcome to Acme",
  "status": "draft",
  "html": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve a single template by id, including html (which List templates omits). Use this to read the body, then save changes with Update a template. Requires the templates:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields8 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`subject`required	object	—
`status`required	enumdraft \| published	—
`html`	object	—
`created_at`required	string	—
`updated_at`required	string	—

200401404

Update a template

PATCH/api/v1/email/templates/{id}

PATCH /email/templates/{id}

curl -X PATCH 'https://www.unitpost.com/api/v1/email/templates/tmpl_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "subject": "Welcome aboard!"
  }'

Response · 200

{
  "object": "template",
  "id": "id_123",
  "name": "Example",
  "subject": "Welcome to Acme",
  "status": "draft",
  "html": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update a template's metadata and/or html. Changes take effect for future sends only — emails already sent or queued keep the body they were rendered with. Writing html switches the template to code mode. Read the current body first with Retrieve a template. Requires the templates:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body5 fields

Field	Type	Description
`name`	string	—
`subject`	object	—
`status`	enumdraft \| published	—
`html`	string	The email body as HTML (compose with @unitpost/email `render()` or any HTML; `{{variables}}` fill at send). Pass exactly one of `html` or `text`.
`text`	string	Simple email body instead of `html` — plain text exactly as you'd type it into Gmail: lines, a blank line between paragraphs, '- ' or '1. ' list items, and inline <b>, <i>, <u>, <a href="…"> for emphasis and links. No Markdown (it stays literal). Sent as a bare mail-client fragment with no layout or colours; marketing templates get a one-line unsubscribe footer at send time. Max 20,000 characters. Pass exactly one of `html` or `text`.

Response · 200 fields8 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`subject`required	object	—
`status`required	enumdraft \| published	—
`html`	object	—
`created_at`required	string	—
`updated_at`required	string	—

200401404422

Delete a template

DELETE/api/v1/email/templates/{id}

DELETE /email/templates/{id}

curl -X DELETE 'https://www.unitpost.com/api/v1/email/templates/tmpl_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Permanently delete a template. Emails already sent with it are unaffected, but future sends that reference its id will fail — update any code or campaigns that still point at it first (see List campaigns). Requires the templates:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

204401404

Brand kits

Read-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).

List brand kits

GET/api/v1/brand-kits

GET /brand-kits

curl -X GET 'https://www.unitpost.com/api/v1/brand-kits' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "data": [
    {
      "object": "brand_kit",
      "id": "id_123",
      "name": "Example",
      "is_default": false,
      "website_url": "https://example.com",
      "description": "string",
      "tone": "NEUTRAL",
      "voice_notes": "string",
      "industry": "string",
      "core_pages": [
        {
          "url": "https://example.com",
          "title": "string"
        }
      ],
      "extracted": {
        "colors": [
          {
            "hex": "string",
            "label": "string"
          }
        ],
        "logo_urls": [
          "string"
        ],
        "background_urls": [
          "string"
        ],
        "fonts": [
          "string"
        ]
      },
      "graphics": [
        {
          "library_image_id": "library_image_123",
          "role": "logo",
          "label": "string"
        }
      ],
      "source": "string",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "default_id": "default_123"
}

Retrieve every Brand Kit profile in the workspace (up to five named profiles). Each profile holds tone, about, voice notes, labeled colors, pinned logo/background library images, and core pages — the primary brand context for on-brand template authoring. Pass ?name= to filter to one profile by display name (case-insensitive). The response includes default_id for the Default profile. Fetch one by id with Retrieve a brand kit. Writes and URL import stay in the dashboard (Settings → Brand). Requires the templates:read capability.

Parameters1 field

Field	Type	Description
`name`	string · query	Filter to a single profile by display name (case-insensitive).

Response · 200 fields14 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`is_default`required	boolean	—
`website_url`required	object	—
`description`required	object	—
`tone`required	object	—
`voice_notes`required	object	—
`industry`required	object	—
`core_pages`required	object[]	—
`extracted`required	object	—
`graphics`required	object[]	—
`source`required	object	—
`updated_at`required	object	—

200401403

Retrieve a brand kit

GET/api/v1/brand-kits/{id}

GET /brand-kits/{id}

curl -X GET 'https://www.unitpost.com/api/v1/brand-kits/123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "brand_kit",
  "id": "id_123",
  "name": "Example",
  "is_default": false,
  "website_url": "https://example.com",
  "description": "string",
  "tone": "NEUTRAL",
  "voice_notes": "string",
  "industry": "string",
  "core_pages": [
    {
      "url": "https://example.com",
      "title": "string"
    }
  ],
  "extracted": {
    "colors": [
      {
        "hex": "string",
        "label": "string"
      }
    ],
    "logo_urls": [
      "string"
    ],
    "background_urls": [
      "string"
    ],
    "fonts": [
      "string"
    ]
  },
  "graphics": [
    {
      "library_image_id": "library_image_123",
      "role": "logo",
      "label": "string"
    }
  ],
  "source": "string",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve one Brand Kit profile by id (bk_…), including voice, labeled colors, pinned graphics (library_image_id for /img/{id} in design TSX), and core pages. List every profile with List brand kits. Requires the templates:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields14 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`is_default`required	boolean	—
`website_url`required	object	—
`description`required	object	—
`tone`required	object	—
`voice_notes`required	object	—
`industry`required	object	—
`core_pages`required	object[]	—
`extracted`required	object	—
`graphics`required	object[]	—
`source`required	object	—
`updated_at`required	object	—

200401403404

Domains

The 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.

List domains

GET/api/v1/email/domains

GET /email/domains

curl -X GET 'https://www.unitpost.com/api/v1/email/domains' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "domain",
      "id": "id_123",
      "name": "Example",
      "status": "pending",
      "records": [
        {
          "type": "string",
          "name": "Example",
          "value": "string",
          "priority": 0
        }
      ],
      "dkim_selector": "string",
      "open_tracking": false,
      "click_tracking": false,
      "tls": "opportunistic",
      "tracking_subdomain": "string",
      "tracking_verified_at": "2026-01-01T00:00:00.000Z",
      "verified_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve a list of your sending domains, cursor-paginated, with each domain's verification status. Add a new one with Add a domain, or fetch a single domain (including its DNS records) with Retrieve a domain. Requires the domains:read capability.

Parameters3 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

Response · 200 fields14 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`status`required	enumpending \| verifying \| verified \| degraded \| failed	—
`records`required	object	—
`dkim_selector`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`tls`required	enumopportunistic \| enforced	—
`tracking_subdomain`required	object	—
`tracking_verified_at`required	object	—
`verified_at`required	object	—
`created_at`required	string	—
`updated_at`required	string	—

200401422

Add a domain

POST/api/v1/email/domains

POST /email/domains

curl -X POST 'https://www.unitpost.com/api/v1/email/domains' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "yourdomain.com"
  }'

Response · 201

{
  "object": "domain",
  "id": "id_123",
  "name": "Example",
  "status": "pending",
  "records": [
    {
      "type": "string",
      "name": "Example",
      "value": "string",
      "priority": 0
    }
  ],
  "dkim_selector": "string",
  "open_tracking": false,
  "click_tracking": false,
  "tls": "opportunistic",
  "tracking_subdomain": "string",
  "tracking_verified_at": "2026-01-01T00:00:00.000Z",
  "verified_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Add a domain you'll send email from. The response includes the DNS records (SPF, DKIM, and so on) to publish with your DNS provider. Once they're published, trigger a check with Verify a domain — sending from the domain is blocked until it verifies. Requires the domains:write capability.

Request body1 field

Field	Type	Description
`name`required	string	—

Response · 201 fields14 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`status`required	enumpending \| verifying \| verified \| degraded \| failed	—
`records`required	object	—
`dkim_selector`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`tls`required	enumopportunistic \| enforced	—
`tracking_subdomain`required	object	—
`tracking_verified_at`required	object	—
`verified_at`required	object	—
`created_at`required	string	—
`updated_at`required	string	—

201401409422

Retrieve a domain

GET/api/v1/email/domains/{id}

GET /email/domains/{id}

curl -X GET 'https://www.unitpost.com/api/v1/email/domains/dom_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "domain",
  "id": "id_123",
  "name": "Example",
  "status": "pending",
  "records": [
    {
      "type": "string",
      "name": "Example",
      "value": "string",
      "priority": 0
    }
  ],
  "dkim_selector": "string",
  "open_tracking": false,
  "click_tracking": false,
  "tls": "opportunistic",
  "tracking_subdomain": "string",
  "tracking_verified_at": "2026-01-01T00:00:00.000Z",
  "verified_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve a single sending domain by id, including its current verification status and the DNS records you need to publish. Re-run the DNS check with Verify a domain, or change its tracking/TLS settings with Update a domain. Requires the domains:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields14 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`status`required	enumpending \| verifying \| verified \| degraded \| failed	—
`records`required	object	—
`dkim_selector`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`tls`required	enumopportunistic \| enforced	—
`tracking_subdomain`required	object	—
`tracking_verified_at`required	object	—
`verified_at`required	object	—
`created_at`required	string	—
`updated_at`required	string	—

200401404

Update a domain

PATCH/api/v1/email/domains/{id}

PATCH /email/domains/{id}

curl -X PATCH 'https://www.unitpost.com/api/v1/email/domains/dom_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "click_tracking": true,
    "open_tracking": true
  }'

Response · 200

{
  "object": "domain",
  "id": "id_123",
  "name": "Example",
  "status": "pending",
  "records": [
    {
      "type": "string",
      "name": "Example",
      "value": "string",
      "priority": 0
    }
  ],
  "dkim_selector": "string",
  "open_tracking": false,
  "click_tracking": false,
  "tls": "opportunistic",
  "tracking_subdomain": "string",
  "tracking_verified_at": "2026-01-01T00:00:00.000Z",
  "verified_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update a domain's sending options: open/click tracking defaults, TLS enforcement, and the tracking subdomain. These act as the domain-level defaults that individual emails and campaigns can override (see Update a campaign). Requires the domains:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body4 fields

Field	Type	Description
`open_tracking`	object	—
`click_tracking`	object	—
`tls`	enumopportunistic \| enforced	—
`tracking_subdomain`	object	—

Response · 200 fields14 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`status`required	enumpending \| verifying \| verified \| degraded \| failed	—
`records`required	object	—
`dkim_selector`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`tls`required	enumopportunistic \| enforced	—
`tracking_subdomain`required	object	—
`tracking_verified_at`required	object	—
`verified_at`required	object	—
`created_at`required	string	—
`updated_at`required	string	—

200401404422

Delete a domain

DELETE/api/v1/email/domains/{id}

DELETE /email/domains/{id}

curl -X DELETE 'https://www.unitpost.com/api/v1/email/domains/dom_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Remove a sending domain from your workspace. Sends that reference an address on this domain will be rejected afterwards, so update your from addresses first. Re-add it any time with Add a domain (you'll need to verify it again). Requires the domains:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

204401404

Verify a domain

POST/api/v1/email/domains/{id}/verify

POST /email/domains/{id}/verify

curl -X POST 'https://www.unitpost.com/api/v1/email/domains/dom_123/verify' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "domain",
  "id": "id_123",
  "name": "Example",
  "status": "pending",
  "records": [
    {
      "type": "string",
      "name": "Example",
      "value": "string",
      "priority": 0
    }
  ],
  "dkim_selector": "string",
  "open_tracking": false,
  "click_tracking": false,
  "tls": "opportunistic",
  "tracking_subdomain": "string",
  "tracking_verified_at": "2026-01-01T00:00:00.000Z",
  "verified_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "checks": [
    "string"
  ]
}

Run an on-demand DNS check and advance the domain's verification status. The response includes per-record checks so you can see exactly which DNS records are still missing or wrong. Get the records to publish from Retrieve a domain. Verification also re-runs periodically in the background. Requires the domains:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields15 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`status`required	enumpending \| verifying \| verified \| degraded \| failed	—
`records`required	object	—
`dkim_selector`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`tls`required	enumopportunistic \| enforced	—
`tracking_subdomain`required	object	—
`tracking_verified_at`required	object	—
`verified_at`required	object	—
`created_at`required	string	—
`updated_at`required	string	—
`checks`	object[]	—

200401404409502

Email

Emails

List sent emails

Send or schedule an email

Send a batch of emails

Retrieve a batch

Cancel a batch

Retrieve an email

Cancel or reschedule an email

Email deliverability stats

Inbound emails

List received emails

Retrieve a received email

Get an attachment download URL

Topics

List topics

Create a topic

Retrieve a topic

Update a topic

Delete a topic

List a contact's topic subscriptions

Set a contact's topic preference

Set a contact's topic preference (alias of POST)

Campaigns

List campaigns

Create a campaign

Retrieve a campaign

Update a campaign

Delete a campaign

Send a campaign

Cancel a campaign

Pause a campaign

Resume a campaign

Reschedule a campaign

Validate a campaign

Templates

List templates

Create a template

Retrieve a template

Update a template

Delete a template

Brand kits

List brand kits

Retrieve a brand kit

Domains

List domains

Add a domain

Retrieve a domain

Update a domain

Delete a domain

Verify a domain

Search docs and guides