Temp Mail API Documentation - Boomlify

Complete API reference for temporary email service integration

POST`/api/v1/emails/create`

Crear una nueva dirección de correo temporal Ahora admite el parámetro opcional custom_username para crear correos con direcciones personalizadas.

Parameters:

custom_username (query, optional): Nombre de usuario personalizado opcional para la dirección de correo. Puede contener letras, números, puntos, guiones y guiones bajos. Debe tener entre 3 y 30 caracteres. Si se omite, se generará un nombre de usuario aleatorio. - Example: john.doe
time (query, optional): Tiempo de expiración - Example: permanent
domain (query, optional): Dominio personalizado opcional para la dirección de correo. Debe ser un dominio verificado en tu cuenta (usa el endpoint custom_domains para verificar). Si no se especifica, se usará un dominio público aleatorio. - Example: mail.yourdomain.com
create_as_dashboard (query, optional): 💎 Función Premium - Establece en "true" para crear un correo estilo panel almacenado en la base de datos con expiración fija de 2 meses en lugar de un correo API basado en tiempo. Omite o establece en "false" para correos basados en tiempo (por defecto). Los correos del panel cuestan 15 créditos. Los usuarios del nivel gratuito recibirán un error 403. - Example: true

Error Responses:

INVALID_USERNAME (400): La validación del nombre de usuario personalizado falló. Debe tener entre 3 y 30 caracteres solo con caracteres válidos.
EMAIL_IN_USE (409): El nombre de usuario personalizado ya está tomado. Elige un nombre de usuario diferente.
DOMAIN_NOT_FOUND (400): El dominio especificado no existe o no está verificado. Verifícalo primero en tu cuenta.
DOMAIN_NOT_VERIFIED (400): El dominio existe pero aún no está verificado. Completa primero la verificación del dominio.
DAILY_LIMIT_EXCEEDED (429): Has alcanzado tu límite diario para este tipo de correo

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

GET`/api/v1/emails`

Listar todos tus correos temporales activos

Parameters:

include_expired (query, optional): Incluir correos expirados - Example: true
permanent_only (query, optional): Mostrar solo tus buzones permanentes guardados. Cuesta 2 créditos por solicitud. - Example: true
include_permanent (query, optional): Incluir tus buzones permanentes guardados junto con los recientes. Cuesta 2 créditos por solicitud. - Example: true
limit (query, optional): Número de correos a devolver - Example: 50

Error Responses:

INSUFFICIENT_CREDITS (402): Devuelto cuando se intenta listar buzones permanentes guardados pero la cuenta carece de créditos.

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

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

Obtener detalles de un correo específico

Parameters:

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

Error Responses:

EMAIL_NOT_FOUND (404): El ID del correo es inválido o el correo ha expirado

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

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

Obtener mensajes para un correo específico

Parameters:

id (path, required): ID del correo - Example: 550e8400-e29b-41d4-a716-446655440000
limit (query, optional): Número de mensajes a devolver - Example: 50
offset (query, optional): Número de mensajes a omitir - Example: 0

Error Responses:

EMAIL_NOT_FOUND (404): El ID del correo es inválido o el correo ha expirado
INVALID_LIMIT (400): El parámetro límite está fuera del rango válido

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

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

Eliminar un correo por ID. Admite tanto correos API basados en tiempo (en memoria, eliminados inmediatamente) como correos del panel (persistentes en base de datos, eliminados inmediatamente). Devuelve 404 si el correo no se encuentra o ya fue eliminado.

Parameters:

id (path, required): ID del correo (formato UUID). Puede ser un ID de correo API basado en tiempo o un ID de correo del panel creado con create_as_dashboard=true - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): El correo no existe o ya ha sido eliminado

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

GET`/api/v1/emails`

💎 Función Premium - Listar todos los correos, incluyendo correos creados en el panel. Este endpoint fusiona correos creados por API con tus correos del panel en una sola respuesta. Cuesta 2 créditos por solicitud. Requiere plan Basic o superior.

Parameters:

include_dashboard (query, required): Debe establecerse en "true" para acceder a los correos del panel. Esto activa la función premium y cobra 2 créditos. - Example: true
include_expired (query, optional): Incluir correos expirados en la respuesta (correos API y correos del panel) - Example: false
limit (query, optional): Número máximo de correos a devolver (máx: 100) - Example: 50

Error Responses:

TIER_RESTRICTED (403): Esta es una función premium. Los usuarios del nivel gratuito no pueden acceder a correos del panel a través de la API.
INSUFFICIENT_CREDITS (402): Esta operación cuesta 2 créditos. Por favor, agrega más créditos a tu cuenta.

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

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

💎 Función Premium - Obtener información detallada sobre un correo específico del panel. Si el correo no se encuentra en el almacenamiento API, busca en tus correos del panel. Cuesta 1 crédito por solicitud. Requiere plan Basic o superior.

Parameters:

id (path, required): ID del correo del panel (formato UUID) - Copia esto desde tu panel o desde el endpoint list-dashboard-emails - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Debe ser "true" para buscar correos del panel. Cobra 1 crédito. - Example: true

Error Responses:

TIER_RESTRICTED (403): El acceso a correos del panel requiere un plan de pago
INSUFFICIENT_CREDITS (402): Esta operación cuesta 1 crédito
EMAIL_NOT_FOUND (404): El correo solicitado no fue encontrado o ha expirado

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

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

💎 Función Premium - Recuperar todos los mensajes recibidos para un correo del panel con soporte de paginación. Usa caché para tiempos de respuesta rápidos. Cuesta 1 crédito por solicitud. Requiere plan Basic o superior.

Parameters:

id (path, required): ID del correo del panel - El UUID del correo para el cual deseas obtener mensajes - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Debe ser "true" para acceder a los mensajes del correo del panel. Cobra 1 crédito. - Example: true
limit (query, optional): Número máximo de mensajes a devolver por página (máx: 100) - Example: 20
offset (query, optional): Número de mensajes a omitir para paginación (ej: offset=20 con limit=20 obtiene la página 2) - Example: 0

Error Responses:

TIER_RESTRICTED (403): El acceso a correos del panel requiere un plan de pago
INSUFFICIENT_CREDITS (402): Esta operación cuesta 1 crédito
EMAIL_NOT_FOUND (404): El correo solicitado no fue encontrado o ha expirado

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`

💎 Función Premium - Crear un nuevo correo con nombre de usuario personalizado opcional. Los correos del panel (create_as_dashboard=true) se almacenan en la base de datos con expiración fija de 2 meses y cuestan 15 créditos. Los correos API basados en tiempo admiten opciones de tiempo personalizadas (10min, 1hour, 1day, permanent). Ambos admiten custom_username. Requiere plan Basic o superior.

Parameters:

create_as_dashboard (query, optional): Establece en "true" para crear un correo estilo panel almacenado en la base de datos con expiración fija de 2 meses. Si se omite, crea un correo API basado en tiempo en memoria. Ambos admiten custom_username. - Example: true
custom_username (query, optional): Nombre de usuario personalizado opcional para la dirección de correo. Puede contener letras, números, puntos, guiones y guiones bajos. Debe tener entre 3 y 30 caracteres. Si se omite, se generará un nombre de usuario aleatorio. - Example: john.doe
domain (query, optional): Nombre de dominio personalizado opcional para la dirección de correo. Si no se especifica, se usará un dominio público aleatorio. - Example: mail.yourdomain.com

Error Responses:

TIER_RESTRICTED (403): La creación de correos del panel requiere un plan de pago
INSUFFICIENT_CREDITS (402): Esta operación cuesta 15 créditos
INVALID_USERNAME (400): La validación del nombre de usuario personalizado falló. Debe tener entre 3 y 30 caracteres solo con caracteres válidos.
EMAIL_IN_USE (409): El nombre de usuario personalizado ya está tomado. Elige un nombre de usuario diferente.
INVALID_TIME_PARAMETER (400): El tiempo debe ser uno de: 10min, 1hour, 1day, permanent

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

GET`/api/v1/account/usage`

Obtener tus estadísticas de uso de API

Error Responses:

UNAUTHORIZED (401): La clave API es requerida y debe ser válida

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

GET`/api/v1/account/info`

Obtener información de tu cuenta

Error Responses:

UNAUTHORIZED (401): La clave API es requerida y debe ser válida

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

GET`/api/v1/account/credits`

Obtener información detallada del balance de créditos y uso

Error Responses:

UNAUTHORIZED (401): La clave API es requerida y debe ser válida

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

Centro de Documentación y Pruebas de la API de Temp Mail

Lee la documentación, prueba endpoints y copia código — todo en una sola página.

URL base:

https://v1.boomlify.com

Inicio rápido

Emails

💎 Dashboard API (Premium)

Cuenta

POST /api/v1/emails/create

Crear una nueva dirección de correo temporal Ahora admite el parámetro opcional custom_username para crear correos con direcciones personalizadas.

Requiere autenticaciónCon límite de tasa

Documentación

Parámetros

consulta

custom_username

Nombre de usuario personalizado opcional para la dirección de correo. Puede contener letras, números, puntos, guiones y guiones bajos. Debe tener entre 3 y 30 caracteres. Si se omite, se generará un nombre de usuario aleatorio.

Ejemplo: john.doe

⚠️ ⚠️ Debe tener entre 3 y 30 caracteres. No puede comenzar/terminar con caracteres especiales. Debe ser único. Devuelve 409 si ya está tomado.

consulta

time

Tiempo de expiración

Ejemplo: permanent

⚠️ Debe ser uno de: 10min, 1hour, 1day, permanent

consulta

domain

Dominio personalizado opcional para la dirección de correo. Debe ser un dominio verificado en tu cuenta (usa el endpoint custom_domains para verificar). Si no se especifica, se usará un dominio público aleatorio.

Ejemplo: mail.yourdomain.com

⚠️ ⚠️ Debe ser un dominio personalizado verificado o un dominio público. Devuelve 400 si no está disponible.

consulta

create_as_dashboard

💎 Función Premium - Establece en "true" para crear un correo estilo panel almacenado en la base de datos con expiración fija de 2 meses en lugar de un correo API basado en tiempo. Omite o establece en "false" para correos basados en tiempo (por defecto). Los correos del panel cuestan 15 créditos. Los usuarios del nivel gratuito recibirán un error 403.

Ejemplo: true

⚠️ ⚠️ Debe ser "true" u omitido. Los correos del panel requieren plan Basic o superior. Expiración fija de 2 meses (el parámetro tiempo se ignora).

Ejemplos de error

400

INVALID_USERNAME

El nombre de usuario debe tener al menos 3 caracteres

La validación del nombre de usuario personalizado falló. Debe tener entre 3 y 30 caracteres solo con caracteres válidos.

409

EMAIL_IN_USE

La dirección de correo "[email protected]" ya está en uso

El nombre de usuario personalizado ya está tomado. Elige un nombre de usuario diferente.

400

DOMAIN_NOT_FOUND

El dominio "custom.domain" no está disponible. Debe ser un dominio personalizado verificado en tu cuenta o un dominio público.

El dominio especificado no existe o no está verificado. Verifícalo primero en tu cuenta.

400

DOMAIN_NOT_VERIFIED

El dominio personalizado "custom.domain" no está verificado. Estado actual: pendiente

El dominio existe pero aún no está verificado. Completa primero la verificación del dominio.

429

DAILY_LIMIT_EXCEEDED

Límite diario excedido para correos de 1 hora

Has alcanzado tu límite diario para este tipo de correo

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

consulta

include_expired

Incluir correos expirados

Ejemplo: true

⚠️ Debe ser "true" o "false"

consulta

permanent_only

Mostrar solo tus buzones permanentes guardados. Cuesta 2 créditos por solicitud.

Ejemplo: true

⚠️ Debe ser "true" o "false"

consulta

include_permanent

Incluir tus buzones permanentes guardados junto con los recientes. Cuesta 2 créditos por solicitud.

Ejemplo: true

⚠️ Debe ser "true" o "false"

consulta

limit

Número de correos a devolver

Ejemplo: 50

⚠️ Máximo 100 correos

Ejemplos de error

402

INSUFFICIENT_CREDITS

Agrega créditos para listar buzones permanentes.

Devuelto cuando se intenta listar buzones permanentes guardados pero la cuenta carece de créditos.

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

rutaObligatorio

ID del correo

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

⚠️ Debe ser un UUID válido

Ejemplos de error

404

EMAIL_NOT_FOUND

El correo solicitado no fue encontrado o ha expirado

El ID del correo es inválido o el correo ha expirado

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

rutaObligatorio

ID del correo

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

⚠️ Debe ser un UUID válido

consulta

limit

Número de mensajes a devolver

Ejemplo: 50

⚠️ Máximo 100 mensajes

consulta

offset

Número de mensajes a omitir

Ejemplo: 0

⚠️ Debe ser un entero no negativo

Ejemplos de error

404

EMAIL_NOT_FOUND

El correo solicitado no fue encontrado o ha expirado

El ID del correo es inválido o el correo ha expirado

400

INVALID_LIMIT

El límite debe estar entre 1 y 100

El parámetro límite está fuera del rango válido

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

rutaObligatorio

ID del correo (formato UUID). Puede ser un ID de correo API basado en tiempo o un ID de correo del panel creado con create_as_dashboard=true

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

⚠️ Debe ser un UUID válido

Ejemplos de error

404

EMAIL_NOT_FOUND

El correo solicitado no fue encontrado o ha expirado

El correo no existe o ya ha sido eliminado

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

consultaObligatorio

include_dashboard

Debe establecerse en "true" para acceder a los correos del panel. Esto activa la función premium y cobra 2 créditos.

Ejemplo: true

⚠️ Debe ser "true" - Los usuarios del nivel gratuito recibirán un error 403

consulta

include_expired

Incluir correos expirados en la respuesta (correos API y correos del panel)

Ejemplo: false

consulta

limit

Número máximo de correos a devolver (máx: 100)

Ejemplo: 50

⚠️ Debe estar entre 1 y 100

Ejemplos de error

403

TIER_RESTRICTED

El acceso a correos del panel requiere un plan de pago (Basic o superior)

Esta es una función premium. Los usuarios del nivel gratuito no pueden acceder a correos del panel a través de la API.

402

INSUFFICIENT_CREDITS

Se necesitan 2 créditos para listar correos del panel

Esta operación cuesta 2 créditos. Por favor, agrega más créditos a tu cuenta.

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

rutaObligatorio

ID del correo del panel (formato UUID) - Copia esto desde tu panel o desde el endpoint list-dashboard-emails

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

⚠️ Debe ser un UUID válido de tus correos del panel

consultaObligatorio

include_dashboard

Debe ser "true" para buscar correos del panel. Cobra 1 crédito.

Ejemplo: true

Ejemplos de error

403

TIER_RESTRICTED

Función Premium

El acceso a correos del panel requiere un plan de pago

402

INSUFFICIENT_CREDITS

Se necesita 1 crédito para acceder al correo del panel

Esta operación cuesta 1 crédito

404

EMAIL_NOT_FOUND

Correo no encontrado

El correo solicitado no fue encontrado o ha expirado

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

rutaObligatorio

ID del correo del panel - El UUID del correo para el cual deseas obtener mensajes

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

⚠️ Debe ser un UUID válido de tus correos del panel

consultaObligatorio

include_dashboard

Debe ser "true" para acceder a los mensajes del correo del panel. Cobra 1 crédito.

Ejemplo: true

consulta

limit

Número máximo de mensajes a devolver por página (máx: 100)

Ejemplo: 20

⚠️ Debe estar entre 1 y 100

consulta

offset

Número de mensajes a omitir para paginación (ej: offset=20 con limit=20 obtiene la página 2)

Ejemplo: 0

⚠️ Debe ser un entero no negativo

Ejemplos de error

403

TIER_RESTRICTED

Función Premium

El acceso a correos del panel requiere un plan de pago

402

INSUFFICIENT_CREDITS

Se necesita 1 crédito para acceder a los mensajes del correo del panel

Esta operación cuesta 1 crédito

404

EMAIL_NOT_FOUND

Correo no encontrado

El correo solicitado no fue encontrado o ha expirado

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

rutaObligatorio

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

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

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

consultaObligatorio

include_dashboard

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

Ejemplo: true

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

Ejemplos de error

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

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

rutaObligatorio

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

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

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

consultaObligatorio

include_dashboard

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

Ejemplo: true

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

cuerpoObligatorio

is_enabled

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

Ejemplo: true

⚠️ Must be a boolean value

Ejemplos de error

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

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

consultaObligatorio

include_dashboard

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

Ejemplo: true

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

cuerpoObligatorio

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.

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

Ejemplos de error

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.

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Parámetros

consulta

create_as_dashboard

Establece en "true" para crear un correo estilo panel almacenado en la base de datos con expiración fija de 2 meses. Si se omite, crea un correo API basado en tiempo en memoria. Ambos admiten custom_username.

Ejemplo: true

⚠️ ⚠️ Los correos del panel cuestan 15 créditos. Expiración fija de 2 meses (sin parámetro tiempo). Los usuarios del nivel gratuito recibirán un error 403. Omite este parámetro para crear un correo API basado en tiempo con opciones de tiempo personalizadas.

consulta

custom_username

Ejemplo: john.doe

⚠️ ⚠️ Debe tener entre 3 y 30 caracteres. No puede comenzar/terminar con caracteres especiales. Debe ser único en todos tus correos. Si ya está tomado, devuelve 409 Conflict.

consulta

domain

Nombre de dominio personalizado opcional para la dirección de correo. Si no se especifica, se usará un dominio público aleatorio.

Ejemplo: mail.yourdomain.com

⚠️ Debe ser un dominio verificado en tu cuenta

Ejemplos de error

403

TIER_RESTRICTED

Función Premium

La creación de correos del panel requiere un plan de pago

402

INSUFFICIENT_CREDITS

Se necesitan 15 créditos para crear un correo del panel

Esta operación cuesta 15 créditos

400

INVALID_USERNAME

El nombre de usuario debe tener al menos 3 caracteres

La validación del nombre de usuario personalizado falló. Debe tener entre 3 y 30 caracteres solo con caracteres válidos.

409

EMAIL_IN_USE

La dirección de correo "[email protected]" ya está en uso

El nombre de usuario personalizado ya está tomado. Elige un nombre de usuario diferente.

400

INVALID_TIME_PARAMETER

Parámetro de tiempo inválido

El tiempo debe ser uno de: 10min, 1hour, 1day, permanent

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Ejemplos de error

401

UNAUTHORIZED

Clave API inválida o faltante

La clave API es requerida y debe ser válida

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Ejemplos de error

401

UNAUTHORIZED

Clave API inválida o faltante

La clave API es requerida y debe ser válida

Solicitud de ejemplo

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

Fragmentos de código

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

Documentación

Ejemplos de error

401

UNAUTHORIZED

Clave API inválida o faltante

La clave API es requerida y debe ser válida

Solicitud de ejemplo

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

Fragmentos de código

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

Límite: 60 RPMCentro API

Probar API