Temp Mail API Documentation & Testing Hub

Read the docs, test endpoints, and copy code — all on a single page.

Base URL:
https://v1.boomlify.com

POST /api/v1/emails/create

Create a new temporary email address Now supports optional custom_username parameter to create emails with personalized addresses.

Auth RequiredRate Limited

Documentation

Parameters

query
custom_username
Optional custom username for the email address. Can contain letters, numbers, dots, hyphens, and underscores. Must be 3-30 characters. If omitted, a random username is generated.
Example: john.doe
⚠️ ⚠️ Must be 3-30 characters. Cannot start/end with special characters. Must be unique. Returns 409 if taken.
query
time
Expiration time
Example: permanent
⚠️ Must be one of: 10min, 1hour, 1day, permanent
query
domain
Optional custom domain for the email address. Must be a verified domain in your account (use custom_domains endpoint to verify). If not specified, a random public domain is used.
Example: mail.yourdomain.com
⚠️ ⚠️ Must be a verified custom domain or a public domain. Returns 400 if not available.
query
create_as_dashboard
💎 Premium Feature - Set to "true" to create a dashboard-style email stored in database with fixed 2-month expiry instead of a time-based API email. Omit or set to "false" for time-based emails (default). Dashboard emails cost 15 credits. Free tier users will receive 403 error.
Example: true
⚠️ ⚠️ Must be "true" or omitted. Dashboard emails require Basic plan or higher. Fixed 2-month expiry (time parameter is ignored).

Error Examples

400
INVALID_USERNAME
Username must be at least 3 characters
Custom username validation failed. Must be 3-30 characters with valid characters only.
409
EMAIL_IN_USE
Email address "john.doe@domain.com" is already in use
The custom username is already taken. Choose a different username.
400
DOMAIN_NOT_FOUND
Domain "custom.domain" is not available. It must be either a verified custom domain in your account or a public domain.
The specified domain does not exist or is not verified. Verify it in your account first.
400
DOMAIN_NOT_VERIFIED
Custom domain "custom.domain" is not verified. Current status: pending
The domain exists but is not yet verified. Complete domain verification first.
429
DAILY_LIMIT_EXCEEDED
Daily limit exceeded for 1hour emails
You have reached your daily limit for this email type

Example Request

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Code Snippets

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();
API Hub
Test API

Community Chat

100 of 1352 messages

552

👋 Welcome to Community Chat!

You can view messages, but need an account to join the conversation