Getting Started with Postflare

Create Your Account

To get started with Postflare, you'll need to create an account:

1. Visit postflare.dev and click Sign Up
2. Enter your email address and create a password
3. Verify your email address by clicking the link we send you

Get Your API Key

Once your account is created, you'll need an API key to start sending emails:

1. Open API Keys in your dashboard's sidebar
2. Click Create API Key
3. Give your key a descriptive name (e.g., "Production" or "Development")
4. Copy the key — you won't be able to see it again!

Important: Keep your API key secure. Never expose it in client-side code or commit it to version control.

Send Your First Email

With your API key in hand, you can send your first email using our REST API or one of our SDKs.

Using cURL

curl -X POST https://api.postflare.dev/emails \
  -H "Authorization: Bearer sk_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "Your App <hello@yourdomain.com>",
    "to": ["recipient@example.com"],
    "subject": "Hello from Postflare!",
    "html": "<p>This is my first email sent with Postflare.</p>"
  }'

Using Node.js

// Set RESEND_BASE_URL=https://api.postflare.dev in the environment before
// the process starts. Without it the SDK sends to api.resend.com, silently.
import { Resend } from 'resend';

const resend = new Resend('sk_xxxxxxxxx');

const { data, error } = await resend.emails.send({
  from: 'Your App <hello@yourdomain.com>',
  to: ['recipient@example.com'],
  subject: 'Hello from Postflare!',
  html: '<p>This is my first email sent with Postflare.</p>',
});

if (error) {
  console.error('Failed to send:', error);
} else {
  console.log('Email sent:', data.id);
}

Verify Your Domain

For production use, you should verify a custom domain to improve deliverability:

1. Go to Domains in your dashboard
2. Click Add Domain and enter your domain name
3. Add the DNS records we provide (SPF, DKIM, DMARC)
4. Wait for verification — this usually takes a few minutes

Next Steps

• Create an email template
• Set up webhooks for delivery notifications
• Explore the API Reference for all available endpoints