Temp Mail API Documentation - Boomlify

Complete API reference for temporary email service integration

POST`/api/v1/emails/create`

Neue temporäre E-Mail-Adresse erstellen Unterstützt jetzt den optionalen custom_username-Parameter zum Erstellen von E-Mails mit personalisierten Adressen.

Parameters:

custom_username (query, optional): Optionaler benutzerdefinierter Benutzername für die E-Mail-Adresse. Kann Buchstaben, Zahlen, Punkte, Bindestriche und Unterstriche enthalten. Muss 3-30 Zeichen lang sein. Wenn weggelassen, wird ein zufälliger Benutzername generiert. - Example: john.doe
time (query, optional): Ablaufzeit - Example: permanent
domain (query, optional): Optionale benutzerdefinierte Domain für die E-Mail-Adresse. Muss eine in Ihrem Konto verifizierte Domain sein (verwenden Sie den custom_domains-Endpunkt zur Verifizierung). Wenn nicht angegeben, wird eine zufällige öffentliche Domain verwendet. - Example: mail.yourdomain.com
create_as_dashboard (query, optional): 💎 Premium-Funktion - Auf "true" setzen, um eine Dashboard-E-Mail zu erstellen, die in der Datenbank mit fester 2-Monats-Ablaufzeit gespeichert wird, anstatt einer zeitbasierten API-E-Mail. Weglassen oder auf "false" setzen für zeitbasierte E-Mails (Standard). Dashboard-E-Mails kosten 15 Credits. Free-Tier-Benutzer erhalten einen 403-Fehler. - Example: true

Error Responses:

INVALID_USERNAME (400): Validierung des benutzerdefinierten Benutzernamens fehlgeschlagen. Muss 3-30 Zeichen mit nur gültigen Zeichen sein.
EMAIL_IN_USE (409): Der benutzerdefinierte Benutzername ist bereits vergeben. Wählen Sie einen anderen Benutzernamen.
DOMAIN_NOT_FOUND (400): Die angegebene Domain existiert nicht oder ist nicht verifiziert. Verifizieren Sie sie zuerst in Ihrem Konto.
DOMAIN_NOT_VERIFIED (400): Die Domain existiert, ist aber noch nicht verifiziert. Schließen Sie zuerst die Domain-Verifizierung ab.
DAILY_LIMIT_EXCEEDED (429): Sie haben Ihr Tageslimit für diesen E-Mail-Typ erreicht

Auth Required: Yes | Rate Limited: Yes | Group: Quickstart

GET`/api/v1/emails`

Alle Ihre aktiven temporären E-Mails auflisten

Parameters:

include_expired (query, optional): Abgelaufene E-Mails einschließen - Example: true
permanent_only (query, optional): Nur Ihre gespeicherten permanenten Postfächer anzeigen. Kostet 2 Credits pro Anfrage. - Example: true
include_permanent (query, optional): Ihre gespeicherten permanenten Postfächer zusammen mit den neuesten einschließen. Kostet 2 Credits pro Anfrage. - Example: true
limit (query, optional): Anzahl der zurückzugebenden E-Mails - Example: 50

Error Responses:

INSUFFICIENT_CREDITS (402): Zurückgegeben beim Versuch, gespeicherte permanente Postfächer aufzulisten, aber das Konto hat unzureichende Credits.

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails/{id}`

Details einer bestimmten E-Mail abrufen

Parameters:

id (path, required): E-Mail-ID - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): E-Mail-ID ist ungültig oder E-Mail ist abgelaufen

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails/{id}/messages`

Nachrichten für eine bestimmte E-Mail abrufen

Parameters:

id (path, required): E-Mail-ID - Example: 550e8400-e29b-41d4-a716-446655440000
limit (query, optional): Anzahl der zurückzugebenden Nachrichten - Example: 50
offset (query, optional): Anzahl der zu überspringenden Nachrichten - Example: 0

Error Responses:

EMAIL_NOT_FOUND (404): E-Mail-ID ist ungültig oder E-Mail ist abgelaufen
INVALID_LIMIT (400): Limit-Parameter liegt außerhalb des gültigen Bereichs

Auth Required: Yes | Rate Limited: No | Group: Emails

DELETE`/api/v1/emails/{id}`

E-Mail anhand der ID löschen. Unterstützt sowohl zeitbasierte API-E-Mails (im Speicher, sofort gelöscht) als auch Dashboard-E-Mails (datenbankpersistent, sofort gelöscht). Gibt 404 zurück, wenn E-Mail nicht gefunden oder bereits gelöscht wurde.

Parameters:

id (path, required): E-Mail-ID (UUID-Format). Kann eine zeitbasierte API-E-Mail-ID oder eine Dashboard-E-Mail-ID sein, die mit create_as_dashboard=true erstellt wurde - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): E-Mail existiert nicht oder wurde bereits gelöscht

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails`

💎 Premium-Funktion - Alle E-Mails auflisten, einschließlich Dashboard-erstellter E-Mails. Dieser Endpunkt kombiniert API-erstellte E-Mails mit Ihren Dashboard-E-Mails in einer einzigen Antwort. Kostet 2 Credits pro Anfrage. Erfordert Basic-Plan oder höher.

Parameters:

include_dashboard (query, required): Muss auf "true" gesetzt werden, um auf Dashboard-E-Mails zuzugreifen. Dies aktiviert die Premium-Funktion und berechnet 2 Credits. - Example: true
include_expired (query, optional): Abgelaufene E-Mails in die Antwort einschließen (sowohl API- als auch Dashboard-E-Mails) - Example: false
limit (query, optional): Maximale Anzahl zurückzugebender E-Mails (max: 100) - Example: 50

Error Responses:

TIER_RESTRICTED (403): Dies ist eine Premium-Funktion. Free-Tier-Benutzer können nicht über die API auf Dashboard-E-Mails zugreifen.
INSUFFICIENT_CREDITS (402): Diese Operation kostet 2 Credits. Bitte fügen Sie Ihrem Konto weitere Credits hinzu.

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}`

💎 Premium-Funktion - Detaillierte Informationen zu einer bestimmten Dashboard-E-Mail abrufen. Wenn die E-Mail im API-Speicher nicht gefunden wird, durchsucht sie Ihre Dashboard-E-Mails. Kostet 1 Credit pro Anfrage. Erfordert Basic-Plan oder höher.

Parameters:

id (path, required): Dashboard-E-Mail-ID (UUID-Format) - Kopieren Sie dies aus Ihrem Dashboard oder vom list-dashboard-emails-Endpunkt - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Muss "true" sein, um Dashboard-E-Mails zu durchsuchen. Berechnet 1 Credit. - Example: true

Error Responses:

TIER_RESTRICTED (403): Dashboard-E-Mail-Zugriff erfordert einen kostenpflichtigen Plan
INSUFFICIENT_CREDITS (402): Diese Operation kostet 1 Credit
EMAIL_NOT_FOUND (404): Die angeforderte E-Mail wurde nicht gefunden oder ist abgelaufen

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}/messages`

💎 Premium-Funktion - Alle empfangenen Nachrichten für eine Dashboard-E-Mail mit Paginierungsunterstützung abrufen. Verwendet Cache für schnelle Antwortzeiten. Kostet 1 Credit pro Anfrage. Erfordert Basic-Plan oder höher.

Parameters:

id (path, required): Dashboard-E-Mail-ID - Die UUID der E-Mail, für die Sie Nachrichten abrufen möchten - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Muss "true" sein, um auf Dashboard-E-Mail-Nachrichten zuzugreifen. Berechnet 1 Credit. - Example: true
limit (query, optional): Maximale Anzahl zurückzugebender Nachrichten pro Seite (max: 100) - Example: 20
offset (query, optional): Anzahl der für die Paginierung zu überspringenden Nachrichten (z. B. offset=20 mit limit=20 ergibt Seite 2) - Example: 0

Error Responses:

TIER_RESTRICTED (403): Dashboard-E-Mail-Zugriff erfordert einen kostenpflichtigen Plan
INSUFFICIENT_CREDITS (402): Diese Operation kostet 1 Credit
EMAIL_NOT_FOUND (404): Die angeforderte E-Mail wurde nicht gefunden oder ist abgelaufen

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}/telegram-forwarding`

Premium Feature - Get Telegram forwarding status for a specific owned mailbox. Supports dashboard mailboxes and permanent API mailboxes. Ownership is checked through the existing cached mailbox lookup paths, and forwarding state is returned from the forwarding cache. Costs 2 credits per request. Requires Basic plan or higher.

Parameters:

id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding status you want to inspect - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Must be set to "true" to access Telegram forwarding mailbox status. Charges 2 credits. - Example: true

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot access dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/{id}/telegram-forwarding`

Premium Feature - Enable or disable Telegram forwarding for an owned mailbox. Supports dashboard mailboxes and permanent API mailboxes, while reusing the existing forwarding cache and write-through persistence path. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.

Parameters:

id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding you want to update - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Must be set to "true" to update Telegram mailbox forwarding. Charges 2 credits. - Example: true
is_enabled (body, required): Boolean body field. Set true to enable forwarding or false to disable forwarding. - Example: true

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot update dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/telegram-forwarding/bulk-enable`

Premium Feature - Bulk enable Telegram forwarding for multiple owned mailboxes in one API request. Supports dashboard mailboxes and permanent API mailboxes, reuses the existing per-email forwarding enable flow, and respects the active-forwarding limit. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.

Parameters:

include_dashboard (query, required): Must be set to "true" to bulk enable Telegram mailbox forwarding. Charges 2 credits. - Example: true
email_ids (body, required): Body field containing a non-empty array of owned mailbox IDs. In the test form, you can enter a single mailbox ID or a JSON array. - Example: ["550e8400-e29b-41d4-a716-446655440000"]

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot bulk enable dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits total per bulk request.
NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
EMAIL_NOT_FOUND (404): No matching forwardable mailboxes were found.

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/create`

💎 Premium-Funktion - Neue E-Mail mit optionalem benutzerdefiniertem Benutzernamen erstellen. Dashboard-E-Mails (create_as_dashboard=true) werden in der DB mit fester 2-Monats-Ablaufzeit gespeichert und kosten 15 Credits. Zeitbasierte API-E-Mails unterstützen benutzerdefinierte Zeitoptionen (10min, 1hour, 1day, permanent). Beide unterstützen custom_username. Erfordert Basic-Plan oder höher.

Parameters:

create_as_dashboard (query, optional): Auf "true" setzen, um eine Dashboard-E-Mail zu erstellen, die in der Datenbank mit fester 2-Monats-Ablaufzeit gespeichert wird. Wenn weggelassen, wird eine zeitbasierte API-E-Mail im Speicher erstellt. Beide unterstützen custom_username. - Example: true
custom_username (query, optional): Optionaler benutzerdefinierter Benutzername für die E-Mail-Adresse. Kann Buchstaben, Zahlen, Punkte, Bindestriche und Unterstriche enthalten. Muss 3-30 Zeichen lang sein. Wenn weggelassen, wird ein zufälliger Benutzername generiert. - Example: john.doe
domain (query, optional): Optionale benutzerdefinierte Domain für die E-Mail-Adresse. Wenn nicht angegeben, wird eine zufällige öffentliche Domain verwendet. - Example: mail.yourdomain.com

Error Responses:

TIER_RESTRICTED (403): Dashboard-E-Mail-Erstellung erfordert einen kostenpflichtigen Plan
INSUFFICIENT_CREDITS (402): Diese Operation kostet 15 Credits
INVALID_USERNAME (400): Validierung des benutzerdefinierten Benutzernamens fehlgeschlagen. Muss 3-30 Zeichen mit nur gültigen Zeichen sein.
EMAIL_IN_USE (409): Der benutzerdefinierte Benutzername ist bereits vergeben. Wählen Sie einen anderen Benutzernamen.
INVALID_TIME_PARAMETER (400): Zeit muss eines von sein: 10min, 1hour, 1day, permanent

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/account/usage`

Ihre API-Nutzungsstatistiken abrufen

Error Responses:

UNAUTHORIZED (401): API-Schlüssel ist erforderlich und muss gültig sein

Auth Required: Yes | Rate Limited: No | Group: Account

GET`/api/v1/account/info`

Ihre Kontoinformationen abrufen

Error Responses:

UNAUTHORIZED (401): API-Schlüssel ist erforderlich und muss gültig sein

Auth Required: Yes | Rate Limited: No | Group: Account

GET`/api/v1/account/credits`

Detaillierte Kreditbalance und Nutzungsinformationen abrufen

Error Responses:

UNAUTHORIZED (401): API-Schlüssel ist erforderlich und muss gültig sein

Auth Required: Yes | Rate Limited: No | Group: Account

Temp Mail API – Dokumentation & Test‑Hub

Dokumentation lesen, Endpunkte testen und Code kopieren – alles auf einer Seite.

Basis‑URL:

https://v1.boomlify.com

Schnellstart

E‑Mails

💎 Dashboard API (Premium)

Konto

POST /api/v1/emails/create

Neue temporäre E-Mail-Adresse erstellen Unterstützt jetzt den optionalen custom_username-Parameter zum Erstellen von E-Mails mit personalisierten Adressen.

Authentifizierung erforderlichRate‑Limit

Dokumentation

Parameter

query

custom_username

Optionaler benutzerdefinierter Benutzername für die E-Mail-Adresse. Kann Buchstaben, Zahlen, Punkte, Bindestriche und Unterstriche enthalten. Muss 3-30 Zeichen lang sein. Wenn weggelassen, wird ein zufälliger Benutzername generiert.

Beispiel: john.doe

⚠️ ⚠️ Muss 3-30 Zeichen lang sein. Darf nicht mit Sonderzeichen beginnen/enden. Muss eindeutig sein. Gibt 409 zurück, wenn bereits vergeben.

query

time

Ablaufzeit

Beispiel: permanent

⚠️ Muss eines von sein: 10min, 1hour, 1day, permanent

query

domain

Optionale benutzerdefinierte Domain für die E-Mail-Adresse. Muss eine in Ihrem Konto verifizierte Domain sein (verwenden Sie den custom_domains-Endpunkt zur Verifizierung). Wenn nicht angegeben, wird eine zufällige öffentliche Domain verwendet.

Beispiel: mail.yourdomain.com

⚠️ ⚠️ Muss eine verifizierte benutzerdefinierte Domain oder eine öffentliche Domain sein. Gibt 400 zurück, wenn nicht verfügbar.

query

create_as_dashboard

💎 Premium-Funktion - Auf "true" setzen, um eine Dashboard-E-Mail zu erstellen, die in der Datenbank mit fester 2-Monats-Ablaufzeit gespeichert wird, anstatt einer zeitbasierten API-E-Mail. Weglassen oder auf "false" setzen für zeitbasierte E-Mails (Standard). Dashboard-E-Mails kosten 15 Credits. Free-Tier-Benutzer erhalten einen 403-Fehler.

Beispiel: true

⚠️ ⚠️ Muss "true" sein oder weggelassen werden. Dashboard-E-Mails erfordern Basic-Plan oder höher. Feste 2-Monats-Ablaufzeit (Zeitparameter wird ignoriert).

Fehlerbeispiele

400

INVALID_USERNAME

Benutzername muss mindestens 3 Zeichen lang sein

Validierung des benutzerdefinierten Benutzernamens fehlgeschlagen. Muss 3-30 Zeichen mit nur gültigen Zeichen sein.

409

EMAIL_IN_USE

E-Mail-Adresse "[email protected]" wird bereits verwendet

Der benutzerdefinierte Benutzername ist bereits vergeben. Wählen Sie einen anderen Benutzernamen.

400

DOMAIN_NOT_FOUND

Domain "custom.domain" ist nicht verfügbar. Sie muss entweder eine verifizierte benutzerdefinierte Domain in Ihrem Konto oder eine öffentliche Domain sein.

Die angegebene Domain existiert nicht oder ist nicht verifiziert. Verifizieren Sie sie zuerst in Ihrem Konto.

400

DOMAIN_NOT_VERIFIED

Benutzerdefinierte Domain "custom.domain" ist nicht verifiziert. Aktueller Status: ausstehend

Die Domain existiert, ist aber noch nicht verifiziert. Schließen Sie zuerst die Domain-Verifizierung ab.

429

DAILY_LIMIT_EXCEEDED

Tageslimit für 1-Stunden-E-Mails überschritten

Sie haben Ihr Tageslimit für diesen E-Mail-Typ erreicht

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

query

include_expired

Abgelaufene E-Mails einschließen

Beispiel: true

⚠️ Muss "true" oder "false" sein

query

permanent_only

Nur Ihre gespeicherten permanenten Postfächer anzeigen. Kostet 2 Credits pro Anfrage.

Beispiel: true

⚠️ Muss "true" oder "false" sein

query

include_permanent

Ihre gespeicherten permanenten Postfächer zusammen mit den neuesten einschließen. Kostet 2 Credits pro Anfrage.

Beispiel: true

⚠️ Muss "true" oder "false" sein

query

limit

Anzahl der zurückzugebenden E-Mails

Beispiel: 50

⚠️ Maximal 100 E-Mails

Fehlerbeispiele

402

INSUFFICIENT_CREDITS

Fügen Sie Credits hinzu, um permanente Postfächer aufzulisten.

Zurückgegeben beim Versuch, gespeicherte permanente Postfächer aufzulisten, aber das Konto hat unzureichende Credits.

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

pfadPflichtfeld

E-Mail-ID

Beispiel: 550e8400-e29b-41d4-a716-446655440000

⚠️ Muss eine gültige UUID sein

Fehlerbeispiele

404

EMAIL_NOT_FOUND

Die angeforderte E-Mail wurde nicht gefunden oder ist abgelaufen

E-Mail-ID ist ungültig oder E-Mail ist abgelaufen

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

pfadPflichtfeld

E-Mail-ID

Beispiel: 550e8400-e29b-41d4-a716-446655440000

⚠️ Muss eine gültige UUID sein

query

limit

Anzahl der zurückzugebenden Nachrichten

Beispiel: 50

⚠️ Maximal 100 Nachrichten

query

offset

Anzahl der zu überspringenden Nachrichten

Beispiel: 0

⚠️ Muss eine nicht-negative Ganzzahl sein

Fehlerbeispiele

404

EMAIL_NOT_FOUND

Die angeforderte E-Mail wurde nicht gefunden oder ist abgelaufen

E-Mail-ID ist ungültig oder E-Mail ist abgelaufen

400

INVALID_LIMIT

Limit muss zwischen 1 und 100 liegen

Limit-Parameter liegt außerhalb des gültigen Bereichs

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

pfadPflichtfeld

E-Mail-ID (UUID-Format). Kann eine zeitbasierte API-E-Mail-ID oder eine Dashboard-E-Mail-ID sein, die mit create_as_dashboard=true erstellt wurde

Beispiel: 550e8400-e29b-41d4-a716-446655440000

⚠️ Muss eine gültige UUID sein

Fehlerbeispiele

404

EMAIL_NOT_FOUND

Die angeforderte E-Mail wurde nicht gefunden oder ist abgelaufen

E-Mail existiert nicht oder wurde bereits gelöscht

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

queryPflichtfeld

include_dashboard

Muss auf "true" gesetzt werden, um auf Dashboard-E-Mails zuzugreifen. Dies aktiviert die Premium-Funktion und berechnet 2 Credits.

Beispiel: true

⚠️ Muss "true" sein - Free-Tier-Benutzer erhalten einen 403-Fehler

query

include_expired

Abgelaufene E-Mails in die Antwort einschließen (sowohl API- als auch Dashboard-E-Mails)

Beispiel: false

query

limit

Maximale Anzahl zurückzugebender E-Mails (max: 100)

Beispiel: 50

⚠️ Muss zwischen 1 und 100 liegen

Fehlerbeispiele

403

TIER_RESTRICTED

Dashboard-E-Mail-Zugriff erfordert einen kostenpflichtigen Plan (Basic oder höher)

Dies ist eine Premium-Funktion. Free-Tier-Benutzer können nicht über die API auf Dashboard-E-Mails zugreifen.

402

INSUFFICIENT_CREDITS

Benötigt 2 Credits, um Dashboard-E-Mails aufzulisten

Diese Operation kostet 2 Credits. Bitte fügen Sie Ihrem Konto weitere Credits hinzu.

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

pfadPflichtfeld

Dashboard-E-Mail-ID (UUID-Format) - Kopieren Sie dies aus Ihrem Dashboard oder vom list-dashboard-emails-Endpunkt

Beispiel: 550e8400-e29b-41d4-a716-446655440000

⚠️ Muss eine gültige UUID aus Ihren Dashboard-E-Mails sein

queryPflichtfeld

include_dashboard

Muss "true" sein, um Dashboard-E-Mails zu durchsuchen. Berechnet 1 Credit.

Beispiel: true

Fehlerbeispiele

403

TIER_RESTRICTED

Premium-Funktion

Dashboard-E-Mail-Zugriff erfordert einen kostenpflichtigen Plan

402

INSUFFICIENT_CREDITS

Benötigt 1 Credit, um auf Dashboard-E-Mail zuzugreifen

Diese Operation kostet 1 Credit

404

EMAIL_NOT_FOUND

E-Mail nicht gefunden

Die angeforderte E-Mail wurde nicht gefunden oder ist abgelaufen

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

pfadPflichtfeld

Dashboard-E-Mail-ID - Die UUID der E-Mail, für die Sie Nachrichten abrufen möchten

Beispiel: 550e8400-e29b-41d4-a716-446655440000

⚠️ Muss eine gültige UUID aus Ihren Dashboard-E-Mails sein

queryPflichtfeld

include_dashboard

Muss "true" sein, um auf Dashboard-E-Mail-Nachrichten zuzugreifen. Berechnet 1 Credit.

Beispiel: true

query

limit

Maximale Anzahl zurückzugebender Nachrichten pro Seite (max: 100)

Beispiel: 20

⚠️ Muss zwischen 1 und 100 liegen

query

offset

Anzahl der für die Paginierung zu überspringenden Nachrichten (z. B. offset=20 mit limit=20 ergibt Seite 2)

Beispiel: 0

⚠️ Muss eine nicht-negative Ganzzahl sein

Fehlerbeispiele

403

TIER_RESTRICTED

Premium-Funktion

Dashboard-E-Mail-Zugriff erfordert einen kostenpflichtigen Plan

402

INSUFFICIENT_CREDITS

Benötigt 1 Credit, um auf Dashboard-E-Mail-Nachrichten zuzugreifen

Diese Operation kostet 1 Credit

404

EMAIL_NOT_FOUND

E-Mail nicht gefunden

Die angeforderte E-Mail wurde nicht gefunden oder ist abgelaufen

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

pfadPflichtfeld

Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding status you want to inspect

Beispiel: 550e8400-e29b-41d4-a716-446655440000

⚠️ Must be an owned dashboard mailbox ID or permanent API mailbox ID

queryPflichtfeld

include_dashboard

Must be set to "true" to access Telegram forwarding mailbox status. Charges 2 credits.

Beispiel: true

⚠️ Must be "true" - Free tier users will receive a 403 error

Fehlerbeispiele

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot access dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to access dashboard email Telegram forwarding status

This operation costs 2 credits. Please add more credits to your account.

404

EMAIL_NOT_FOUND

Email not found

The requested mailbox was not found, is unsupported, or has expired

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

pfadPflichtfeld

Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding you want to update

Beispiel: 550e8400-e29b-41d4-a716-446655440000

⚠️ Must be an owned dashboard mailbox ID or permanent API mailbox ID

queryPflichtfeld

include_dashboard

Must be set to "true" to update Telegram mailbox forwarding. Charges 2 credits.

Beispiel: true

⚠️ Must be "true" - Free tier users will receive a 403 error

bodyPflichtfeld

is_enabled

Boolean body field. Set true to enable forwarding or false to disable forwarding.

Beispiel: true

⚠️ Must be a boolean value

Fehlerbeispiele

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot update dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to update dashboard email Telegram forwarding

This operation costs 2 credits. Please add more credits to your account.

400

NO_TELEGRAM_BINDING

No active Telegram binding found. Please bind your Telegram account first.

Forwarding cannot be enabled until the account has an active verified Telegram binding.

403

FORWARDING_LIMIT_EXCEEDED

Forwarding limit exceeded

The user has reached the plan limit for active Telegram forwardings.

404

EMAIL_NOT_FOUND

Email not found

The requested mailbox was not found, is unsupported, or has expired

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

queryPflichtfeld

include_dashboard

Must be set to "true" to bulk enable Telegram mailbox forwarding. Charges 2 credits.

Beispiel: true

⚠️ Must be "true" - Free tier users will receive a 403 error

bodyPflichtfeld

email_ids

Body field containing a non-empty array of owned mailbox IDs. In the test form, you can enter a single mailbox ID or a JSON array.

Beispiel: ["550e8400-e29b-41d4-a716-446655440000"]

⚠️ Must resolve to a non-empty array of owned dashboard mailbox IDs or permanent API mailbox IDs. The bulk limit is 150 IDs per request.

Fehlerbeispiele

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot bulk enable dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to bulk enable dashboard email Telegram forwarding

This operation costs 2 credits total per bulk request.

400

NO_TELEGRAM_BINDING

No active Telegram binding found. Please bind your Telegram account first.

Forwarding cannot be enabled until the account has an active verified Telegram binding.

403

FORWARDING_LIMIT_EXCEEDED

Forwarding limit exceeded

The user has reached the plan limit for active Telegram forwardings.

404

EMAIL_NOT_FOUND

Email not found

No matching forwardable mailboxes were found.

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Parameter

query

create_as_dashboard

Auf "true" setzen, um eine Dashboard-E-Mail zu erstellen, die in der Datenbank mit fester 2-Monats-Ablaufzeit gespeichert wird. Wenn weggelassen, wird eine zeitbasierte API-E-Mail im Speicher erstellt. Beide unterstützen custom_username.

Beispiel: true

⚠️ ⚠️ Dashboard-E-Mails kosten 15 Credits. Feste 2-Monats-Ablaufzeit (kein Zeitparameter). Free-Tier-Benutzer erhalten einen 403-Fehler. Lassen Sie diesen Parameter weg, um eine zeitbasierte API-E-Mail mit benutzerdefinierten Zeitoptionen zu erstellen.

query

custom_username

Beispiel: john.doe

⚠️ ⚠️ Muss 3-30 Zeichen lang sein. Darf nicht mit Sonderzeichen beginnen/enden. Muss über alle Ihre E-Mails hinweg eindeutig sein. Wenn bereits vergeben, gibt 409 Conflict zurück.

query

domain

Optionale benutzerdefinierte Domain für die E-Mail-Adresse. Wenn nicht angegeben, wird eine zufällige öffentliche Domain verwendet.

Beispiel: mail.yourdomain.com

⚠️ Muss eine verifizierte Domain in Ihrem Konto sein

Fehlerbeispiele

403

TIER_RESTRICTED

Premium-Funktion

Dashboard-E-Mail-Erstellung erfordert einen kostenpflichtigen Plan

402

INSUFFICIENT_CREDITS

Benötigt 15 Credits, um Dashboard-E-Mail zu erstellen

Diese Operation kostet 15 Credits

400

INVALID_USERNAME

Benutzername muss mindestens 3 Zeichen lang sein

Validierung des benutzerdefinierten Benutzernamens fehlgeschlagen. Muss 3-30 Zeichen mit nur gültigen Zeichen sein.

409

EMAIL_IN_USE

E-Mail-Adresse "[email protected]" wird bereits verwendet

Der benutzerdefinierte Benutzername ist bereits vergeben. Wählen Sie einen anderen Benutzernamen.

400

INVALID_TIME_PARAMETER

Ungültiger Zeitparameter

Zeit muss eines von sein: 10min, 1hour, 1day, permanent

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Fehlerbeispiele

401

UNAUTHORIZED

Ungültiger oder fehlender API-Schlüssel

API-Schlüssel ist erforderlich und muss gültig sein

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Fehlerbeispiele

401

UNAUTHORIZED

Ungültiger oder fehlender API-Schlüssel

API-Schlüssel ist erforderlich und muss gültig sein

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Dokumentation

Fehlerbeispiele

401

UNAUTHORIZED

Ungültiger oder fehlender API-Schlüssel

API-Schlüssel ist erforderlich und muss gültig sein

Beispiel‑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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Limit: 60 RPMAPI‑Hub

API testen