Temp Mail API Documentation - Boomlify

Complete API reference for temporary email service integration

POST`/api/v1/emails/create`

Creare un nuovo indirizzo email temporaneo Ora supporta il parametro opzionale custom_username per creare email con indirizzi personalizzati.

Parameters:

custom_username (query, optional): Nome utente personalizzato opzionale per l'indirizzo email. Può contenere lettere, numeri, punti, trattini e underscore. Deve essere compreso tra 3 e 30 caratteri. Se omesso, verrà generato un nome utente casuale. - Example: john.doe
time (query, optional): Tempo di scadenza - Example: permanent
domain (query, optional): Dominio personalizzato opzionale per l'indirizzo email. Deve essere un dominio verificato nel tuo account (usa l'endpoint custom_domains per verificare). Se non specificato, verrà utilizzato un dominio pubblico casuale. - Example: mail.yourdomain.com
create_as_dashboard (query, optional): 💎 Funzionalità Premium - Imposta su "true" per creare un'email in stile dashboard memorizzata nel database con scadenza fissa di 2 mesi invece di un'email API basata sul tempo. Ometti o imposta su "false" per email basate sul tempo (predefinito). Le email dashboard costano 15 crediti. Gli utenti del livello gratuito riceveranno un errore 403. - Example: true

Error Responses:

INVALID_USERNAME (400): La validazione del nome utente personalizzato è fallita. Deve essere compreso tra 3 e 30 caratteri solo con caratteri validi.
EMAIL_IN_USE (409): Il nome utente personalizzato è già in uso. Scegli un nome utente diverso.
DOMAIN_NOT_FOUND (400): Il dominio specificato non esiste o non è verificato. Verificalo prima nel tuo account.
DOMAIN_NOT_VERIFIED (400): Il dominio esiste ma non è ancora verificato. Completa prima la verifica del dominio.
DAILY_LIMIT_EXCEEDED (429): Hai raggiunto il limite giornaliero per questo tipo di email

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

GET`/api/v1/emails`

Elencare tutte le tue email temporanee attive

Parameters:

include_expired (query, optional): Includere email scadute - Example: true
permanent_only (query, optional): Mostra solo le tue caselle permanenti salvate. Costa 2 crediti per richiesta. - Example: true
include_permanent (query, optional): Includi le tue caselle permanenti salvate insieme a quelle recenti. Costa 2 crediti per richiesta. - Example: true
limit (query, optional): Numero di email da restituire - Example: 50

Error Responses:

INSUFFICIENT_CREDITS (402): Restituito quando si tenta di elencare le caselle permanenti salvate ma l'account ha crediti insufficienti.

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

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

Ottenere dettagli di un'email specifica

Parameters:

id (path, required): ID dell'email - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): L'ID dell'email non è valido o l'email è scaduta

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

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

Ottenere messaggi per un'email specifica

Parameters:

id (path, required): ID dell'email - Example: 550e8400-e29b-41d4-a716-446655440000
limit (query, optional): Numero di messaggi da restituire - Example: 50
offset (query, optional): Numero di messaggi da saltare - Example: 0

Error Responses:

EMAIL_NOT_FOUND (404): L'ID dell'email non è valido o l'email è scaduta
INVALID_LIMIT (400): Il parametro limite è fuori dall'intervallo valido

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

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

Eliminare un'email per ID. Supporta sia email API basate sul tempo (in memoria, eliminate immediatamente) che email dashboard (persistenti nel database, eliminate immediatamente). Restituisce 404 se l'email non viene trovata o è già stata eliminata.

Parameters:

id (path, required): ID dell'email (formato UUID). Può essere un ID email API basato sul tempo o un ID email dashboard creato con create_as_dashboard=true - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): L'email non esiste o è già stata eliminata

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

GET`/api/v1/emails`

💎 Funzionalità Premium - Elencare tutte le email, incluse le email create nella dashboard. Questo endpoint unisce le email create tramite API con le tue email dashboard in una singola risposta. Costa 2 crediti per richiesta. Richiede un piano Basic o superiore.

Parameters:

include_dashboard (query, required): Deve essere impostato su "true" per accedere alle email dashboard. Questo attiva la funzionalità premium e addebita 2 crediti. - Example: true
include_expired (query, optional): Includere email scadute nella risposta (email API e email dashboard) - Example: false
limit (query, optional): Numero massimo di email da restituire (max: 100) - Example: 50

Error Responses:

TIER_RESTRICTED (403): Questa è una funzionalità premium. Gli utenti del livello gratuito non possono accedere alle email dashboard tramite API.
INSUFFICIENT_CREDITS (402): Questa operazione costa 2 crediti. Aggiungi più crediti al tuo account.

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

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

💎 Funzionalità Premium - Ottenere informazioni dettagliate su un'email specifica della dashboard. Se l'email non viene trovata nell'archivio API, cerca nelle tue email dashboard. Costa 1 credito per richiesta. Richiede un piano Basic o superiore.

Parameters:

id (path, required): ID email dashboard (formato UUID) - Copia questo dalla tua dashboard o dall'endpoint list-dashboard-emails - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Deve essere "true" per cercare email dashboard. Addebita 1 credito. - Example: true

Error Responses:

TIER_RESTRICTED (403): L'accesso alle email dashboard richiede un piano a pagamento
INSUFFICIENT_CREDITS (402): Questa operazione costa 1 credito
EMAIL_NOT_FOUND (404): L'email richiesta non è stata trovata o è scaduta

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

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

💎 Funzionalità Premium - Recuperare tutti i messaggi ricevuti per un'email dashboard con supporto alla paginazione. Utilizza la cache per tempi di risposta rapidi. Costa 1 credito per richiesta. Richiede un piano Basic o superiore.

Parameters:

id (path, required): ID email dashboard - L'UUID dell'email per cui desideri recuperare i messaggi - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Deve essere "true" per accedere ai messaggi dell'email dashboard. Addebita 1 credito. - Example: true
limit (query, optional): Numero massimo di messaggi da restituire per pagina (max: 100) - Example: 20
offset (query, optional): Numero di messaggi da saltare per la paginazione (es: offset=20 con limit=20 ottiene la pagina 2) - Example: 0

Error Responses:

TIER_RESTRICTED (403): L'accesso alle email dashboard richiede un piano a pagamento
INSUFFICIENT_CREDITS (402): Questa operazione costa 1 credito
EMAIL_NOT_FOUND (404): L'email richiesta non è stata trovata o è scaduta

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`

💎 Funzionalità Premium - Creare una nuova email con nome utente personalizzato opzionale. Le email dashboard (create_as_dashboard=true) sono memorizzate nel database con scadenza fissa di 2 mesi e costano 15 crediti. Le email API basate sul tempo supportano opzioni di tempo personalizzate (10min, 1hour, 1day, permanent). Entrambe supportano custom_username. Richiede un piano Basic o superiore.

Parameters:

create_as_dashboard (query, optional): Imposta su "true" per creare un'email in stile dashboard memorizzata nel database con scadenza fissa di 2 mesi. Se omesso, crea un'email API basata sul tempo in memoria. Entrambe supportano custom_username. - Example: true
custom_username (query, optional): Nome utente personalizzato opzionale per l'indirizzo email. Può contenere lettere, numeri, punti, trattini e underscore. Deve essere compreso tra 3 e 30 caratteri. Se omesso, verrà generato un nome utente casuale. - Example: john.doe
domain (query, optional): Nome dominio personalizzato opzionale per l'indirizzo email. Se non specificato, verrà utilizzato un dominio pubblico casuale. - Example: mail.yourdomain.com

Error Responses:

TIER_RESTRICTED (403): La creazione di email dashboard richiede un piano a pagamento
INSUFFICIENT_CREDITS (402): Questa operazione costa 15 crediti
INVALID_USERNAME (400): La validazione del nome utente personalizzato è fallita. Deve essere compreso tra 3 e 30 caratteri solo con caratteri validi.
EMAIL_IN_USE (409): Il nome utente personalizzato è già in uso. Scegli un nome utente diverso.
INVALID_TIME_PARAMETER (400): Il tempo deve essere uno di: 10min, 1hour, 1day, permanent

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

GET`/api/v1/account/usage`

Ottenere le tue statistiche di utilizzo API

Error Responses:

UNAUTHORIZED (401): La chiave API è richiesta e deve essere valida

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

GET`/api/v1/account/info`

Ottenere le informazioni del tuo account

Error Responses:

UNAUTHORIZED (401): La chiave API è richiesta e deve essere valida

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

GET`/api/v1/account/credits`

Ottenere informazioni dettagliate sul saldo crediti e utilizzo

Error Responses:

UNAUTHORIZED (401): La chiave API è richiesta e deve essere valida

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

Hub Documentazione e Test API Temp Mail

Leggi la documentazione, testa gli endpoint e copia il codice — tutto in un’unica pagina.

URL base:

https://v1.boomlify.com

Avvio rapido

Email

💎 Dashboard API (Premium)

Account

POST /api/v1/emails/create

Creare un nuovo indirizzo email temporaneo Ora supporta il parametro opzionale custom_username per creare email con indirizzi personalizzati.

Autenticazione richiestaCon limite di frequenza

Documentazione

Parametri

query

custom_username

Nome utente personalizzato opzionale per l'indirizzo email. Può contenere lettere, numeri, punti, trattini e underscore. Deve essere compreso tra 3 e 30 caratteri. Se omesso, verrà generato un nome utente casuale.

Esempio: john.doe

⚠️ ⚠️ Deve essere compreso tra 3 e 30 caratteri. Non può iniziare/terminare con caratteri speciali. Deve essere unico. Restituisce 409 se già in uso.

query

time

Tempo di scadenza

Esempio: permanent

⚠️ Deve essere uno di: 10min, 1hour, 1day, permanent

query

domain

Dominio personalizzato opzionale per l'indirizzo email. Deve essere un dominio verificato nel tuo account (usa l'endpoint custom_domains per verificare). Se non specificato, verrà utilizzato un dominio pubblico casuale.

Esempio: mail.yourdomain.com

⚠️ ⚠️ Deve essere un dominio personalizzato verificato o un dominio pubblico. Restituisce 400 se non disponibile.

query

create_as_dashboard

💎 Funzionalità Premium - Imposta su "true" per creare un'email in stile dashboard memorizzata nel database con scadenza fissa di 2 mesi invece di un'email API basata sul tempo. Ometti o imposta su "false" per email basate sul tempo (predefinito). Le email dashboard costano 15 crediti. Gli utenti del livello gratuito riceveranno un errore 403.

Esempio: true

⚠️ ⚠️ Deve essere "true" o omesso. Le email dashboard richiedono un piano Basic o superiore. Scadenza fissa di 2 mesi (il parametro tempo viene ignorato).

Esempi di errore

400

INVALID_USERNAME

Il nome utente deve contenere almeno 3 caratteri

La validazione del nome utente personalizzato è fallita. Deve essere compreso tra 3 e 30 caratteri solo con caratteri validi.

409

EMAIL_IN_USE

L'indirizzo email "[email protected]" è già in uso

Il nome utente personalizzato è già in uso. Scegli un nome utente diverso.

400

DOMAIN_NOT_FOUND

Il dominio "custom.domain" non è disponibile. Deve essere un dominio personalizzato verificato nel tuo account o un dominio pubblico.

Il dominio specificato non esiste o non è verificato. Verificalo prima nel tuo account.

400

DOMAIN_NOT_VERIFIED

Il dominio personalizzato "custom.domain" non è verificato. Stato attuale: in attesa

Il dominio esiste ma non è ancora verificato. Completa prima la verifica del dominio.

429

DAILY_LIMIT_EXCEEDED

Limite giornaliero superato per email da 1 ora

Hai raggiunto il limite giornaliero per questo tipo di email

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

query

include_expired

Includere email scadute

Esempio: true

⚠️ Deve essere "true" o "false"

query

permanent_only

Mostra solo le tue caselle permanenti salvate. Costa 2 crediti per richiesta.

Esempio: true

⚠️ Deve essere "true" o "false"

query

include_permanent

Includi le tue caselle permanenti salvate insieme a quelle recenti. Costa 2 crediti per richiesta.

Esempio: true

⚠️ Deve essere "true" o "false"

query

limit

Numero di email da restituire

Esempio: 50

⚠️ Massimo 100 email

Esempi di errore

402

INSUFFICIENT_CREDITS

Aggiungi crediti per elencare le caselle permanenti.

Restituito quando si tenta di elencare le caselle permanenti salvate ma l'account ha crediti insufficienti.

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

percorsoObbligatorio

ID dell'email

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

⚠️ Deve essere un UUID valido

Esempi di errore

404

EMAIL_NOT_FOUND

L'email richiesta non è stata trovata o è scaduta

L'ID dell'email non è valido o l'email è scaduta

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

percorsoObbligatorio

ID dell'email

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

⚠️ Deve essere un UUID valido

query

limit

Numero di messaggi da restituire

Esempio: 50

⚠️ Massimo 100 messaggi

query

offset

Numero di messaggi da saltare

Esempio: 0

⚠️ Deve essere un intero non negativo

Esempi di errore

404

EMAIL_NOT_FOUND

L'email richiesta non è stata trovata o è scaduta

L'ID dell'email non è valido o l'email è scaduta

400

INVALID_LIMIT

Il limite deve essere tra 1 e 100

Il parametro limite è fuori dall'intervallo valido

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

percorsoObbligatorio

ID dell'email (formato UUID). Può essere un ID email API basato sul tempo o un ID email dashboard creato con create_as_dashboard=true

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

⚠️ Deve essere un UUID valido

Esempi di errore

404

EMAIL_NOT_FOUND

L'email richiesta non è stata trovata o è scaduta

L'email non esiste o è già stata eliminata

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

queryObbligatorio

include_dashboard

Deve essere impostato su "true" per accedere alle email dashboard. Questo attiva la funzionalità premium e addebita 2 crediti.

Esempio: true

⚠️ Deve essere "true" - Gli utenti del livello gratuito riceveranno un errore 403

query

include_expired

Includere email scadute nella risposta (email API e email dashboard)

Esempio: false

query

limit

Numero massimo di email da restituire (max: 100)

Esempio: 50

⚠️ Deve essere compreso tra 1 e 100

Esempi di errore

403

TIER_RESTRICTED

L'accesso alle email dashboard richiede un piano a pagamento (Basic o superiore)

Questa è una funzionalità premium. Gli utenti del livello gratuito non possono accedere alle email dashboard tramite API.

402

INSUFFICIENT_CREDITS

Sono necessari 2 crediti per elencare le email dashboard

Questa operazione costa 2 crediti. Aggiungi più crediti al tuo account.

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

percorsoObbligatorio

ID email dashboard (formato UUID) - Copia questo dalla tua dashboard o dall'endpoint list-dashboard-emails

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

⚠️ Deve essere un UUID valido dalle tue email dashboard

queryObbligatorio

include_dashboard

Deve essere "true" per cercare email dashboard. Addebita 1 credito.

Esempio: true

Esempi di errore

403

TIER_RESTRICTED

Funzionalità Premium

L'accesso alle email dashboard richiede un piano a pagamento

402

INSUFFICIENT_CREDITS

È necessario 1 credito per accedere all'email dashboard

Questa operazione costa 1 credito

404

EMAIL_NOT_FOUND

Email non trovata

L'email richiesta non è stata trovata o è scaduta

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

percorsoObbligatorio

ID email dashboard - L'UUID dell'email per cui desideri recuperare i messaggi

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

⚠️ Deve essere un UUID valido dalle tue email dashboard

queryObbligatorio

include_dashboard

Deve essere "true" per accedere ai messaggi dell'email dashboard. Addebita 1 credito.

Esempio: true

query

limit

Numero massimo di messaggi da restituire per pagina (max: 100)

Esempio: 20

⚠️ Deve essere compreso tra 1 e 100

query

offset

Numero di messaggi da saltare per la paginazione (es: offset=20 con limit=20 ottiene la pagina 2)

Esempio: 0

⚠️ Deve essere un intero non negativo

Esempi di errore

403

TIER_RESTRICTED

Funzionalità Premium

L'accesso alle email dashboard richiede un piano a pagamento

402

INSUFFICIENT_CREDITS

È necessario 1 credito per accedere ai messaggi dell'email dashboard

Questa operazione costa 1 credito

404

EMAIL_NOT_FOUND

Email non trovata

L'email richiesta non è stata trovata o è scaduta

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

percorsoObbligatorio

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

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

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

queryObbligatorio

include_dashboard

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

Esempio: true

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

Esempi di errore

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

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

percorsoObbligatorio

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

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

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

queryObbligatorio

include_dashboard

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

Esempio: true

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

corpoObbligatorio

is_enabled

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

Esempio: true

⚠️ Must be a boolean value

Esempi di errore

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

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

queryObbligatorio

include_dashboard

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

Esempio: true

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

corpoObbligatorio

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.

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

Esempi di errore

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.

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Parametri

query

create_as_dashboard

Imposta su "true" per creare un'email in stile dashboard memorizzata nel database con scadenza fissa di 2 mesi. Se omesso, crea un'email API basata sul tempo in memoria. Entrambe supportano custom_username.

Esempio: true

⚠️ ⚠️ Le email dashboard costano 15 crediti. Scadenza fissa di 2 mesi (nessun parametro tempo). Gli utenti del livello gratuito riceveranno un errore 403. Ometti questo parametro per creare un'email API basata sul tempo con opzioni di tempo personalizzate.

query

custom_username

Esempio: john.doe

⚠️ ⚠️ Deve essere compreso tra 3 e 30 caratteri. Non può iniziare/terminare con caratteri speciali. Deve essere unico tra tutte le tue email. Se già in uso, restituisce 409 Conflict.

query

domain

Nome dominio personalizzato opzionale per l'indirizzo email. Se non specificato, verrà utilizzato un dominio pubblico casuale.

Esempio: mail.yourdomain.com

⚠️ Deve essere un dominio verificato nel tuo account

Esempi di errore

403

TIER_RESTRICTED

Funzionalità Premium

La creazione di email dashboard richiede un piano a pagamento

402

INSUFFICIENT_CREDITS

Sono necessari 15 crediti per creare un'email dashboard

Questa operazione costa 15 crediti

400

INVALID_USERNAME

Il nome utente deve contenere almeno 3 caratteri

La validazione del nome utente personalizzato è fallita. Deve essere compreso tra 3 e 30 caratteri solo con caratteri validi.

409

EMAIL_IN_USE

L'indirizzo email "[email protected]" è già in uso

Il nome utente personalizzato è già in uso. Scegli un nome utente diverso.

400

INVALID_TIME_PARAMETER

Parametro tempo non valido

Il tempo deve essere uno di: 10min, 1hour, 1day, permanent

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Esempi di errore

401

UNAUTHORIZED

Chiave API non valida o mancante

La chiave API è richiesta e deve essere valida

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Esempi di errore

401

UNAUTHORIZED

Chiave API non valida o mancante

La chiave API è richiesta e deve essere valida

Richiesta di esempio

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

Snippet di codice

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

Documentazione

Esempi di errore

401

UNAUTHORIZED

Chiave API non valida o mancante

La chiave API è richiesta e deve essere valida

Richiesta di esempio

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

Snippet di codice

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

Limite: 60 RPMHub API

Test API