Onboarding

DevelEmail accounts are invite-only. This guide takes you from your invite link to a first sent email and, when you outgrow the Free plan, an upgrade.

1. Accept your invitation

Open the invitation link an admin of your organization sent you. There is no public signup: only an organization invitation link lets you create an account.

2. Sign up and accept the terms

On the signup page, choose a password and tick the box to accept the Terms of Service. The Privacy Policy and Acceptable Use Policy apply too.

3. Verify your email

We send a verification email to the address you signed up with. Sending email through the API is blocked (EMAIL_NOT_VERIFIED) until you follow the link in it.

4. Add your sending domain and publish DNS

devel domains add example.com
devel domains records <domain-id>

add creates the domain and prints the DNS records it needs. Publish them at your DNS provider, or push them to Cloudflare with devel domains publish-dns <domain-id>. See the CLI Reference for every flag.

5. Verify the domain

devel domains verify <domain-id> --wait

--wait polls until the records are visible. Until the domain is verified, sends from it fail with domain_not_verified.

6. Create an API key

Create a key in the dashboard, or with the CLI:

devel key create --project <project-id> --name production

The key is shown once. Store it as a secret.

7. Send your first email

npm install @develemail/sdk

import { DevelEmail } from '@develemail/sdk';

const client = new DevelEmail({ apiKey: process.env.DEVELEMAIL_API_KEY! });

await client.emails.send({
  from: '[email protected]',
  to: '[email protected]',
  subject: 'It works',
  text: 'Hello from DevelEmail.',
});

The from address must belong to a verified domain. See the SDK Reference for the full API.

New organizations start on the new reputation tier, which has low daily and per-minute sending caps. Read the sending policy before your first real campaign.

8. Test with the sandbox

Send to any address at @sandbox.develemail.com. The API accepts the send and records it with status sandboxed, but delivers nothing and does not count it against your quota. A single send can't mix sandbox and real recipients (mixed_sandbox_recipients).

9. Upgrade your plan

Org admins can see usage and pick a plan under Settings → Billing in the dashboard. Plan limits are described in Accounts & billing.