Get started
Introduction
Refresh is an email platform for senders with many domains. It manages domains, API keys, sending, deliverability and audience in one console and one API.
Refresh sends transactional and bulk messages from domains that you own. The platform manages authentication (DKIM, SPF, DMARC), suppression, unsubscribe and tracking for you. Apps send through a small HTTP API or the SMTP relay. People work in the console.
Concepts
| Concept | What it is |
|---|---|
| Organization | The tenant. INTERNAL (a brand you own) or CLIENT. Every domain, API key, contact and message belongs to exactly one organization; nothing crosses organizations. |
| Domain | A sending domain (example.com) with its own DKIM keys (ep1, ep2), Return-Path host (bounce.example.com) and DMARC record. A domain must have status VERIFIED before it can send. See Verify a domain. |
| API key | A bearer token (f5_live_…) that you mint in the console. SEND or FULL permission, optionally restricted to specific domains. See Authentication. |
| Transport | How the messages of a domain leave the platform: SES (default) or SES_SECONDARY (the second delivery region, used as the failover of an SES domain). Selected per domain; invisible to the API. Each message records the transport that sent it. |
| SMTP relay | smtp.f5send.com:465. Accepts mail from any SMTP client with the id of an API key as the username and the token as the password. Each message becomes one POST /emails. See SMTP relay. |
| Kind | A free-form label on a message (kind: "digest.weekly"). Kinds with the prefix bulk., broadcast., digest. or sequence. are bulk messages and get one-click unsubscribe headers. See Unsubscribe & tracking. |
Base URL
https://api.f5send.com/api/v1
All requests carry Authorization: Bearer <api key> and a JSON body. All responses are JSON. All errors have one shape. See Errors.
Where to go next
- Quickstart — mint an API key and send a message in two minutes.
- Emails API — every field on
POST /emails. - SMTP relay — send from Postfix, WordPress or any program that cannot call HTTP.
- Webhooks — receive delivery events with signed payloads.
- Migrating from Resend — usually a one-file change.
- Migrating from SendGrid — map the v3 mail body, the Event Webhook and suppression groups.