Temp Mail API Documentation - Boomlify

Complete API reference for temporary email service integration

POST`/api/v1/emails/create`

Een nieuw tijdelijk e-mailadres aanmaken Ondersteunt nu de optionele parameter custom_username om e-mails met gepersonaliseerde adressen aan te maken.

Parameters:

custom_username (query, optional): Optionele aangepaste gebruikersnaam voor het e-mailadres. Kan letters, cijfers, punten, streepjes en underscores bevatten. Moet tussen 3 en 30 tekens lang zijn. Indien weggelaten, wordt een willekeurige gebruikersnaam gegenereerd. - Example: john.doe
time (query, optional): Vervaltijd - Example: permanent
domain (query, optional): Optioneel aangepast domein voor het e-mailadres. Moet een geverifieerd domein in je account zijn (gebruik het custom_domains endpoint om te verifiëren). Indien niet opgegeven, wordt een willekeurig openbaar domein gebruikt. - Example: mail.yourdomain.com
create_as_dashboard (query, optional): 💎 Premium Functie - Stel in op "true" om een dashboard-stijl e-mail aan te maken die in de database wordt opgeslagen met een vaste vervaltijd van 2 maanden in plaats van een tijdgebaseerde API-e-mail. Laat weg of stel in op "false" voor tijdgebaseerde e-mails (standaard). Dashboard e-mails kosten 15 credits. Gebruikers van de gratis tier ontvangen een 403-fout. - Example: true

Error Responses:

INVALID_USERNAME (400): Validatie van aangepaste gebruikersnaam mislukt. Moet tussen 3 en 30 tekens lang zijn met alleen geldige tekens.
EMAIL_IN_USE (409): De aangepaste gebruikersnaam is al in gebruik. Kies een andere gebruikersnaam.
DOMAIN_NOT_FOUND (400): Het opgegeven domein bestaat niet of is niet geverifieerd. Verifieer het eerst in je account.
DOMAIN_NOT_VERIFIED (400): Het domein bestaat maar is nog niet geverifieerd. Voltooi eerst de domeinverificatie.
DAILY_LIMIT_EXCEEDED (429): Je hebt je dagelijkse limiet bereikt voor dit type e-mail

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

GET`/api/v1/emails`

Al je actieve tijdelijke e-mails weergeven

Parameters:

include_expired (query, optional): Vervallen e-mails opnemen - Example: true
permanent_only (query, optional): Alleen je opgeslagen permanente inboxen tonen. Kost 2 credits per verzoek. - Example: true
include_permanent (query, optional): Je opgeslagen permanente inboxen samen met recente opnemen. Kost 2 credits per verzoek. - Example: true
limit (query, optional): Aantal te retourneren e-mails - Example: 50

Error Responses:

INSUFFICIENT_CREDITS (402): Teruggegeven bij het proberen om opgeslagen permanente inboxen weer te geven maar het account heeft onvoldoende credits.

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

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

Details van een specifieke e-mail ophalen

Parameters:

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

Error Responses:

EMAIL_NOT_FOUND (404): E-mail ID is ongeldig of e-mail is verlopen

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

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

Berichten voor een specifieke e-mail ophalen

Parameters:

id (path, required): E-mail ID - Example: 550e8400-e29b-41d4-a716-446655440000
limit (query, optional): Aantal te retourneren berichten - Example: 50
offset (query, optional): Aantal over te slaan berichten - Example: 0

Error Responses:

EMAIL_NOT_FOUND (404): E-mail ID is ongeldig of e-mail is verlopen
INVALID_LIMIT (400): Limietparameter valt buiten het geldige bereik

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

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

Een e-mail verwijderen op ID. Ondersteunt zowel tijdgebaseerde API-e-mails (in geheugen, onmiddellijk verwijderd) als dashboard e-mails (persistent in database, onmiddellijk verwijderd). Retourneert 404 als e-mail niet gevonden of al verwijderd is.

Parameters:

id (path, required): E-mail ID (UUID-formaat). Kan een tijdgebaseerde API-e-mail ID of een dashboard e-mail ID zijn die is aangemaakt met create_as_dashboard=true - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): E-mail bestaat niet of is al verwijderd

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

GET`/api/v1/emails`

💎 Premium Functie - Alle e-mails weergeven, inclusief dashboard-aangemaakte e-mails. Dit endpoint combineert API-aangemaakte e-mails met je dashboard e-mails in een enkele respons. Kost 2 credits per verzoek. Vereist Basic plan of hoger.

Parameters:

include_dashboard (query, required): Moet worden ingesteld op "true" om toegang te krijgen tot dashboard e-mails. Dit activeert de premium functie en brengt 2 credits in rekening. - Example: true
include_expired (query, optional): Vervallen e-mails opnemen in de respons (zowel API- als dashboard e-mails) - Example: false
limit (query, optional): Maximaal aantal te retourneren e-mails (max: 100) - Example: 50

Error Responses:

TIER_RESTRICTED (403): Dit is een premium functie. Gebruikers van de gratis tier kunnen niet via de API toegang krijgen tot dashboard e-mails.
INSUFFICIENT_CREDITS (402): Deze operatie kost 2 credits. Voeg meer credits toe aan je account.

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

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

💎 Premium Functie - Gedetailleerde informatie over een specifieke dashboard e-mail ophalen. Als de e-mail niet wordt gevonden in de API-opslag, zoekt het in je dashboard e-mails. Kost 1 crediet per verzoek. Vereist Basic plan of hoger.

Parameters:

id (path, required): Dashboard e-mail ID (UUID-formaat) - Kopieer dit vanuit je dashboard of vanuit het list-dashboard-emails endpoint - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Moet "true" zijn om dashboard e-mails te zoeken. Brengt 1 crediet in rekening. - Example: true

Error Responses:

TIER_RESTRICTED (403): Toegang tot dashboard e-mails vereist een betaald plan
INSUFFICIENT_CREDITS (402): Deze operatie kost 1 crediet
EMAIL_NOT_FOUND (404): De gevraagde e-mail is niet gevonden of verlopen

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

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

💎 Premium Functie - Alle ontvangen berichten voor een dashboard e-mail ophalen met pagineringondersteuning. Gebruikt cache voor snelle responstijden. Kost 1 crediet per verzoek. Vereist Basic plan of hoger.

Parameters:

id (path, required): Dashboard e-mail ID - De UUID van de e-mail waarvoor je berichten wilt ophalen - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Moet "true" zijn om toegang te krijgen tot dashboard e-mailberichten. Brengt 1 crediet in rekening. - Example: true
limit (query, optional): Maximaal aantal te retourneren berichten per pagina (max: 100) - Example: 20
offset (query, optional): Aantal over te slaan berichten voor paginering (bijv. offset=20 met limit=20 geeft pagina 2) - Example: 0

Error Responses:

TIER_RESTRICTED (403): Toegang tot dashboard e-mails vereist een betaald plan
INSUFFICIENT_CREDITS (402): Deze operatie kost 1 crediet
EMAIL_NOT_FOUND (404): De gevraagde e-mail is niet gevonden of verlopen

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 Functie - Een nieuwe e-mail aanmaken met optionele aangepaste gebruikersnaam. Dashboard e-mails (create_as_dashboard=true) worden opgeslagen in de database met een vaste vervaltijd van 2 maanden en kosten 15 credits. Tijdgebaseerde API-e-mails ondersteunen aangepaste tijdopties (10min, 1hour, 1day, permanent). Beide ondersteunen custom_username. Vereist Basic plan of hoger.

Parameters:

create_as_dashboard (query, optional): Stel in op "true" om een dashboard-stijl e-mail aan te maken die in de database wordt opgeslagen met een vaste vervaltijd van 2 maanden. Indien weggelaten, wordt een tijdgebaseerde API-e-mail in geheugen aangemaakt. Beide ondersteunen custom_username. - Example: true
custom_username (query, optional): Optionele aangepaste gebruikersnaam voor het e-mailadres. Kan letters, cijfers, punten, streepjes en underscores bevatten. Moet tussen 3 en 30 tekens lang zijn. Indien weggelaten, wordt een willekeurige gebruikersnaam gegenereerd. - Example: john.doe
domain (query, optional): Optionele aangepaste domeinnaam voor het e-mailadres. Indien niet opgegeven, wordt een willekeurig openbaar domein gebruikt. - Example: mail.yourdomain.com

Error Responses:

TIER_RESTRICTED (403): Het aanmaken van dashboard e-mails vereist een betaald plan
INSUFFICIENT_CREDITS (402): Deze operatie kost 15 credits
INVALID_USERNAME (400): Validatie van aangepaste gebruikersnaam mislukt. Moet tussen 3 en 30 tekens lang zijn met alleen geldige tekens.
EMAIL_IN_USE (409): De aangepaste gebruikersnaam is al in gebruik. Kies een andere gebruikersnaam.
INVALID_TIME_PARAMETER (400): Tijd moet een van de volgende zijn: 10min, 1hour, 1day, permanent

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

GET`/api/v1/account/usage`

Je API-gebruiksstatistieken ophalen

Error Responses:

UNAUTHORIZED (401): API-sleutel is verplicht en moet geldig zijn

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

GET`/api/v1/account/info`

Je accountinformatie ophalen

Error Responses:

UNAUTHORIZED (401): API-sleutel is verplicht en moet geldig zijn

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

GET`/api/v1/account/credits`

Gedetailleerde creditssaldo en gebruiksinformatie ophalen

Error Responses:

UNAUTHORIZED (401): API-sleutel is verplicht en moet geldig zijn

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

Temp Mail API Documentatie & Testhub

Lees de documentatie, test endpoints en kopieer code — alles op één pagina.

Basis‑URL:

https://v1.boomlify.com

Snelstart

E‑mails

💎 Dashboard API (Premium)

Account

POST /api/v1/emails/create

Een nieuw tijdelijk e-mailadres aanmaken Ondersteunt nu de optionele parameter custom_username om e-mails met gepersonaliseerde adressen aan te maken.

Authenticatie vereistMet snelheidslimiet

Documentatie

Parameters

query

custom_username

Optionele aangepaste gebruikersnaam voor het e-mailadres. Kan letters, cijfers, punten, streepjes en underscores bevatten. Moet tussen 3 en 30 tekens lang zijn. Indien weggelaten, wordt een willekeurige gebruikersnaam gegenereerd.

Voorbeeld: john.doe

⚠️ ⚠️ Moet tussen 3 en 30 tekens lang zijn. Mag niet beginnen/eindigen met speciale tekens. Moet uniek zijn. Retourneert 409 indien al in gebruik.

query

time

Vervaltijd

Voorbeeld: permanent

⚠️ Moet een van de volgende zijn: 10min, 1hour, 1day, permanent

query

domain

Optioneel aangepast domein voor het e-mailadres. Moet een geverifieerd domein in je account zijn (gebruik het custom_domains endpoint om te verifiëren). Indien niet opgegeven, wordt een willekeurig openbaar domein gebruikt.

Voorbeeld: mail.yourdomain.com

⚠️ ⚠️ Moet een geverifieerd aangepast domein of een openbaar domein zijn. Retourneert 400 indien niet beschikbaar.

query

create_as_dashboard

💎 Premium Functie - Stel in op "true" om een dashboard-stijl e-mail aan te maken die in de database wordt opgeslagen met een vaste vervaltijd van 2 maanden in plaats van een tijdgebaseerde API-e-mail. Laat weg of stel in op "false" voor tijdgebaseerde e-mails (standaard). Dashboard e-mails kosten 15 credits. Gebruikers van de gratis tier ontvangen een 403-fout.

Voorbeeld: true

⚠️ ⚠️ Moet "true" zijn of weggelaten worden. Dashboard e-mails vereisen een Basic plan of hoger. Vaste vervaltijd van 2 maanden (tijdparameter wordt genegeerd).

Foutvoorbeelden

400

INVALID_USERNAME

Gebruikersnaam moet minimaal 3 tekens lang zijn

Validatie van aangepaste gebruikersnaam mislukt. Moet tussen 3 en 30 tekens lang zijn met alleen geldige tekens.

409

EMAIL_IN_USE

E-mailadres "[email protected]" is al in gebruik

De aangepaste gebruikersnaam is al in gebruik. Kies een andere gebruikersnaam.

400

DOMAIN_NOT_FOUND

Domein "custom.domain" is niet beschikbaar. Het moet een geverifieerd aangepast domein in je account of een openbaar domein zijn.

Het opgegeven domein bestaat niet of is niet geverifieerd. Verifieer het eerst in je account.

400

DOMAIN_NOT_VERIFIED

Aangepast domein "custom.domain" is niet geverifieerd. Huidige status: in afwachting

Het domein bestaat maar is nog niet geverifieerd. Voltooi eerst de domeinverificatie.

429

DAILY_LIMIT_EXCEEDED

Dagelijkse limiet overschreden voor 1-uur e-mails

Je hebt je dagelijkse limiet bereikt voor dit type e-mail

Voorbeeldverzoek

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);

Documentatie

Parameters

query

include_expired

Vervallen e-mails opnemen

Voorbeeld: true

⚠️ Moet "true" of "false" zijn

query

permanent_only

Alleen je opgeslagen permanente inboxen tonen. Kost 2 credits per verzoek.

Voorbeeld: true

⚠️ Moet "true" of "false" zijn

query

include_permanent

Je opgeslagen permanente inboxen samen met recente opnemen. Kost 2 credits per verzoek.

Voorbeeld: true

⚠️ Moet "true" of "false" zijn

query

limit

Aantal te retourneren e-mails

Voorbeeld: 50

⚠️ Maximaal 100 e-mails

Foutvoorbeelden

402

INSUFFICIENT_CREDITS

Voeg credits toe om permanente inboxen weer te geven.

Teruggegeven bij het proberen om opgeslagen permanente inboxen weer te geven maar het account heeft onvoldoende credits.

Voorbeeldverzoek

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);

Documentatie

Parameters

padVereist

E-mail ID

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

⚠️ Moet een geldige UUID zijn

Foutvoorbeelden

404

EMAIL_NOT_FOUND

De gevraagde e-mail is niet gevonden of verlopen

E-mail ID is ongeldig of e-mail is verlopen

Voorbeeldverzoek

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);

Documentatie

Parameters

padVereist

E-mail ID

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

⚠️ Moet een geldige UUID zijn

query

limit

Aantal te retourneren berichten

Voorbeeld: 50

⚠️ Maximaal 100 berichten

query

offset

Aantal over te slaan berichten

Voorbeeld: 0

⚠️ Moet een niet-negatief geheel getal zijn

Foutvoorbeelden

404

EMAIL_NOT_FOUND

De gevraagde e-mail is niet gevonden of verlopen

E-mail ID is ongeldig of e-mail is verlopen

400

INVALID_LIMIT

Limiet moet tussen 1 en 100 liggen

Limietparameter valt buiten het geldige bereik

Voorbeeldverzoek

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);

Documentatie

Parameters

padVereist

E-mail ID (UUID-formaat). Kan een tijdgebaseerde API-e-mail ID of een dashboard e-mail ID zijn die is aangemaakt met create_as_dashboard=true

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

⚠️ Moet een geldige UUID zijn

Foutvoorbeelden

404

EMAIL_NOT_FOUND

De gevraagde e-mail is niet gevonden of verlopen

E-mail bestaat niet of is al verwijderd

Voorbeeldverzoek

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);

Documentatie

Parameters

queryVereist

include_dashboard

Moet worden ingesteld op "true" om toegang te krijgen tot dashboard e-mails. Dit activeert de premium functie en brengt 2 credits in rekening.

Voorbeeld: true

⚠️ Moet "true" zijn - Gebruikers van de gratis tier ontvangen een 403-fout

query

include_expired

Vervallen e-mails opnemen in de respons (zowel API- als dashboard e-mails)

Voorbeeld: false

query

limit

Maximaal aantal te retourneren e-mails (max: 100)

Voorbeeld: 50

⚠️ Moet tussen 1 en 100 liggen

Foutvoorbeelden

403

TIER_RESTRICTED

Toegang tot dashboard e-mails vereist een betaald plan (Basic of hoger)

Dit is een premium functie. Gebruikers van de gratis tier kunnen niet via de API toegang krijgen tot dashboard e-mails.

402

INSUFFICIENT_CREDITS

2 credits nodig om dashboard e-mails weer te geven

Deze operatie kost 2 credits. Voeg meer credits toe aan je account.

Voorbeeldverzoek

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);

Documentatie

Parameters

padVereist

Dashboard e-mail ID (UUID-formaat) - Kopieer dit vanuit je dashboard of vanuit het list-dashboard-emails endpoint

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

⚠️ Moet een geldige UUID zijn van je dashboard e-mails

queryVereist

include_dashboard

Moet "true" zijn om dashboard e-mails te zoeken. Brengt 1 crediet in rekening.

Voorbeeld: true

Foutvoorbeelden

403

TIER_RESTRICTED

Premium Functie

Toegang tot dashboard e-mails vereist een betaald plan

402

INSUFFICIENT_CREDITS

1 crediet nodig om toegang te krijgen tot dashboard e-mail

Deze operatie kost 1 crediet

404

EMAIL_NOT_FOUND

E-mail niet gevonden

De gevraagde e-mail is niet gevonden of verlopen

Voorbeeldverzoek

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);

Documentatie

Parameters

padVereist

Dashboard e-mail ID - De UUID van de e-mail waarvoor je berichten wilt ophalen

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

⚠️ Moet een geldige UUID zijn van je dashboard e-mails

queryVereist

include_dashboard

Moet "true" zijn om toegang te krijgen tot dashboard e-mailberichten. Brengt 1 crediet in rekening.

Voorbeeld: true

query

limit

Maximaal aantal te retourneren berichten per pagina (max: 100)

Voorbeeld: 20

⚠️ Moet tussen 1 en 100 liggen

query

offset

Aantal over te slaan berichten voor paginering (bijv. offset=20 met limit=20 geeft pagina 2)

Voorbeeld: 0

⚠️ Moet een niet-negatief geheel getal zijn

Foutvoorbeelden

403

TIER_RESTRICTED

Premium Functie

Toegang tot dashboard e-mails vereist een betaald plan

402

INSUFFICIENT_CREDITS

1 crediet nodig om toegang te krijgen tot dashboard e-mailberichten

Deze operatie kost 1 crediet

404

EMAIL_NOT_FOUND

E-mail niet gevonden

De gevraagde e-mail is niet gevonden of verlopen

Voorbeeldverzoek

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);

Documentatie

Parameters

padVereist

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

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

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

queryVereist

include_dashboard

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

Voorbeeld: true

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

Foutvoorbeelden

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

Voorbeeldverzoek

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);

Documentatie

Parameters

padVereist

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

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

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

queryVereist

include_dashboard

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

Voorbeeld: true

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

bodyVereist

is_enabled

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

Voorbeeld: true

⚠️ Must be a boolean value

Foutvoorbeelden

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

Voorbeeldverzoek

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);

Documentatie

Parameters

queryVereist

include_dashboard

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

Voorbeeld: true

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

bodyVereist

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.

Voorbeeld: ["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.

Foutvoorbeelden

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.

Voorbeeldverzoek

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);

Documentatie

Parameters

query

create_as_dashboard

Stel in op "true" om een dashboard-stijl e-mail aan te maken die in de database wordt opgeslagen met een vaste vervaltijd van 2 maanden. Indien weggelaten, wordt een tijdgebaseerde API-e-mail in geheugen aangemaakt. Beide ondersteunen custom_username.

Voorbeeld: true

⚠️ ⚠️ Dashboard e-mails kosten 15 credits. Vaste vervaltijd van 2 maanden (geen tijdparameter). Gebruikers van de gratis tier ontvangen een 403-fout. Laat deze parameter weg om een tijdgebaseerde API-e-mail aan te maken met aangepaste tijdopties.

query

custom_username

Voorbeeld: john.doe

⚠️ ⚠️ Moet tussen 3 en 30 tekens lang zijn. Mag niet beginnen/eindigen met speciale tekens. Moet uniek zijn onder al je e-mails. Indien al in gebruik, retourneert 409 Conflict.

query

domain

Optionele aangepaste domeinnaam voor het e-mailadres. Indien niet opgegeven, wordt een willekeurig openbaar domein gebruikt.

Voorbeeld: mail.yourdomain.com

⚠️ Moet een geverifieerd domein in je account zijn

Foutvoorbeelden

403

TIER_RESTRICTED

Premium Functie

Het aanmaken van dashboard e-mails vereist een betaald plan

402

INSUFFICIENT_CREDITS

15 credits nodig om een dashboard e-mail aan te maken

Deze operatie kost 15 credits

400

INVALID_USERNAME

Gebruikersnaam moet minimaal 3 tekens lang zijn

Validatie van aangepaste gebruikersnaam mislukt. Moet tussen 3 en 30 tekens lang zijn met alleen geldige tekens.

409

EMAIL_IN_USE

E-mailadres "[email protected]" is al in gebruik

De aangepaste gebruikersnaam is al in gebruik. Kies een andere gebruikersnaam.

400

INVALID_TIME_PARAMETER

Ongeldige tijdparameter

Tijd moet een van de volgende zijn: 10min, 1hour, 1day, permanent

Voorbeeldverzoek

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);

Documentatie

Foutvoorbeelden

401

UNAUTHORIZED

Ongeldige of ontbrekende API-sleutel

API-sleutel is verplicht en moet geldig zijn

Voorbeeldverzoek

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);

Documentatie

Foutvoorbeelden

401

UNAUTHORIZED

Ongeldige of ontbrekende API-sleutel

API-sleutel is verplicht en moet geldig zijn

Voorbeeldverzoek

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);

Documentatie

Foutvoorbeelden

401

UNAUTHORIZED

Ongeldige of ontbrekende API-sleutel

API-sleutel is verplicht en moet geldig zijn

Voorbeeldverzoek

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);

Limiet: 60 RPMAPI‑hub

API testen