Temp Mail API Documentation - Boomlify

Complete API reference for temporary email service integration

POST`/api/v1/emails/create`

Criar um novo endereço de email temporário Agora suporta o parâmetro opcional custom_username para criar emails com endereços personalizados.

Parameters:

custom_username (query, optional): Nome de usuário personalizado opcional para o endereço de email. Pode conter letras, números, pontos, hífens e sublinhados. Deve ter entre 3 e 30 caracteres. Se omitido, um nome de usuário aleatório será gerado. - Example: john.doe
time (query, optional): Tempo de expiração - Example: permanent
domain (query, optional): Domínio personalizado opcional para o endereço de email. Deve ser um domínio verificado na sua conta (use o endpoint custom_domains para verificar). Se não especificado, um domínio público aleatório será usado. - Example: mail.yourdomain.com
create_as_dashboard (query, optional): 💎 Recurso Premium - Defina como "true" para criar um email estilo painel armazenado no banco de dados com expiração fixa de 2 meses em vez de um email API baseado em tempo. Omita ou defina como "false" para emails baseados em tempo (padrão). Emails do painel custam 15 créditos. Usuários do nível gratuito receberão erro 403. - Example: true

Error Responses:

INVALID_USERNAME (400): Validação do nome de usuário personalizado falhou. Deve ter entre 3 e 30 caracteres apenas com caracteres válidos.
EMAIL_IN_USE (409): O nome de usuário personalizado já está em uso. Escolha um nome de usuário diferente.
DOMAIN_NOT_FOUND (400): O domínio especificado não existe ou não está verificado. Verifique-o primeiro na sua conta.
DOMAIN_NOT_VERIFIED (400): O domínio existe mas ainda não está verificado. Complete a verificação do domínio primeiro.
DAILY_LIMIT_EXCEEDED (429): Você atingiu seu limite diário para este tipo de email

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

GET`/api/v1/emails`

Listar todos os seus emails temporários ativos

Parameters:

include_expired (query, optional): Incluir emails expirados - Example: true
permanent_only (query, optional): Mostrar apenas suas caixas permanentes salvas. Custa 2 créditos por solicitação. - Example: true
include_permanent (query, optional): Incluir suas caixas permanentes salvas junto com as recentes. Custa 2 créditos por solicitação. - Example: true
limit (query, optional): Número de emails para retornar - Example: 50

Error Responses:

INSUFFICIENT_CREDITS (402): Retornado ao tentar listar caixas permanentes salvas mas a conta tem créditos insuficientes.

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

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

Obter detalhes de um email específico

Parameters:

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

Error Responses:

EMAIL_NOT_FOUND (404): ID do email é inválido ou email expirou

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

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

Obter mensagens para um email específico

Parameters:

id (path, required): ID do email - Example: 550e8400-e29b-41d4-a716-446655440000
limit (query, optional): Número de mensagens para retornar - Example: 50
offset (query, optional): Número de mensagens para pular - Example: 0

Error Responses:

EMAIL_NOT_FOUND (404): ID do email é inválido ou email expirou
INVALID_LIMIT (400): Parâmetro limite está fora do intervalo válido

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

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

Excluir um email por ID. Suporta tanto emails API baseados em tempo (na memória, excluídos imediatamente) quanto emails do painel (persistentes no banco de dados, excluídos imediatamente). Retorna 404 se o email não for encontrado ou já foi excluído.

Parameters:

id (path, required): ID do email (formato UUID). Pode ser um ID de email API baseado em tempo ou um ID de email do painel criado com create_as_dashboard=true - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): O email não existe ou já foi excluído

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

GET`/api/v1/emails`

💎 Recurso Premium - Listar todos os emails, incluindo emails criados no painel. Este endpoint mescla emails criados via API com seus emails do painel em uma única resposta. Custa 2 créditos por solicitação. Requer plano Basic ou superior.

Parameters:

include_dashboard (query, required): Deve ser definido como "true" para acessar emails do painel. Isso ativa o recurso premium e cobra 2 créditos. - Example: true
include_expired (query, optional): Incluir emails expirados na resposta (emails API e emails do painel) - Example: false
limit (query, optional): Número máximo de emails para retornar (máx: 100) - Example: 50

Error Responses:

TIER_RESTRICTED (403): Este é um recurso premium. Usuários do nível gratuito não podem acessar emails do painel via API.
INSUFFICIENT_CREDITS (402): Esta operação custa 2 créditos. Por favor, adicione mais créditos à sua conta.

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

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

💎 Recurso Premium - Obter informações detalhadas sobre um email específico do painel. Se o email não for encontrado no armazenamento API, ele busca em seus emails do painel. Custa 1 crédito por solicitação. Requer plano Basic ou superior.

Parameters:

id (path, required): ID do email do painel (formato UUID) - Copie isso do seu painel ou do endpoint list-dashboard-emails - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Deve ser "true" para buscar emails do painel. Cobra 1 crédito. - Example: true

Error Responses:

TIER_RESTRICTED (403): Acesso a emails do painel requer um plano pago
INSUFFICIENT_CREDITS (402): Esta operação custa 1 crédito
EMAIL_NOT_FOUND (404): O email solicitado não foi encontrado ou expirou

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

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

💎 Recurso Premium - Recuperar todas as mensagens recebidas para um email do painel com suporte a paginação. Usa cache para tempos de resposta rápidos. Custa 1 crédito por solicitação. Requer plano Basic ou superior.

Parameters:

id (path, required): ID do email do painel - O UUID do email para o qual você deseja obter mensagens - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Deve ser "true" para acessar mensagens do email do painel. Cobra 1 crédito. - Example: true
limit (query, optional): Número máximo de mensagens para retornar por página (máx: 100) - Example: 20
offset (query, optional): Número de mensagens para pular para paginação (ex: offset=20 com limit=20 obtém página 2) - Example: 0

Error Responses:

TIER_RESTRICTED (403): Acesso a emails do painel requer um plano pago
INSUFFICIENT_CREDITS (402): Esta operação custa 1 crédito
EMAIL_NOT_FOUND (404): O email solicitado não foi encontrado ou expirou

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`

💎 Recurso Premium - Criar um novo email com nome de usuário personalizado opcional. Emails do painel (create_as_dashboard=true) são armazenados no banco de dados com expiração fixa de 2 meses e custam 15 créditos. Emails API baseados em tempo suportam opções de tempo personalizadas (10min, 1hour, 1day, permanent). Ambos suportam custom_username. Requer plano Basic ou superior.

Parameters:

create_as_dashboard (query, optional): Defina como "true" para criar um email estilo painel armazenado no banco de dados com expiração fixa de 2 meses. Se omitido, cria um email API baseado em tempo na memória. Ambos suportam custom_username. - Example: true
custom_username (query, optional): Nome de usuário personalizado opcional para o endereço de email. Pode conter letras, números, pontos, hífens e sublinhados. Deve ter entre 3 e 30 caracteres. Se omitido, um nome de usuário aleatório será gerado. - Example: john.doe
domain (query, optional): Nome de domínio personalizado opcional para o endereço de email. Se não especificado, um domínio público aleatório será usado. - Example: mail.yourdomain.com

Error Responses:

TIER_RESTRICTED (403): Criação de emails do painel requer um plano pago
INSUFFICIENT_CREDITS (402): Esta operação custa 15 créditos
INVALID_USERNAME (400): Validação do nome de usuário personalizado falhou. Deve ter entre 3 e 30 caracteres apenas com caracteres válidos.
EMAIL_IN_USE (409): O nome de usuário personalizado já está em uso. Escolha um nome de usuário diferente.
INVALID_TIME_PARAMETER (400): Tempo deve ser um de: 10min, 1hour, 1day, permanent

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

GET`/api/v1/account/usage`

Obter suas estatísticas de uso da API

Error Responses:

UNAUTHORIZED (401): Chave API é obrigatória e deve ser válida

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

GET`/api/v1/account/info`

Obter informações da sua conta

Error Responses:

UNAUTHORIZED (401): Chave API é obrigatória e deve ser válida

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

GET`/api/v1/account/credits`

Obter informações detalhadas de saldo de créditos e uso

Error Responses:

UNAUTHORIZED (401): Chave API é obrigatória e deve ser válida

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

Hub de Documentação e Testes da API de Temp Mail

Leia a documentação, teste endpoints e copie código — tudo em uma única página.

URL base:

https://v1.boomlify.com

Início rápido

E‑mails

💎 Dashboard API (Premium)

Conta

POST /api/v1/emails/create

Criar um novo endereço de email temporário Agora suporta o parâmetro opcional custom_username para criar emails com endereços personalizados.

Autenticação necessáriaCom limite de taxa

Documentação

Parâmetros

consulta

custom_username

Nome de usuário personalizado opcional para o endereço de email. Pode conter letras, números, pontos, hífens e sublinhados. Deve ter entre 3 e 30 caracteres. Se omitido, um nome de usuário aleatório será gerado.

Exemplo: john.doe

⚠️ ⚠️ Deve ter entre 3 e 30 caracteres. Não pode começar/terminar com caracteres especiais. Deve ser único. Retorna 409 se já estiver em uso.

consulta

time

Tempo de expiração

Exemplo: permanent

⚠️ Deve ser um de: 10min, 1hour, 1day, permanent

consulta

domain

Domínio personalizado opcional para o endereço de email. Deve ser um domínio verificado na sua conta (use o endpoint custom_domains para verificar). Se não especificado, um domínio público aleatório será usado.

Exemplo: mail.yourdomain.com

⚠️ ⚠️ Deve ser um domínio personalizado verificado ou um domínio público. Retorna 400 se não disponível.

consulta

create_as_dashboard

💎 Recurso Premium - Defina como "true" para criar um email estilo painel armazenado no banco de dados com expiração fixa de 2 meses em vez de um email API baseado em tempo. Omita ou defina como "false" para emails baseados em tempo (padrão). Emails do painel custam 15 créditos. Usuários do nível gratuito receberão erro 403.

Exemplo: true

⚠️ ⚠️ Deve ser "true" ou omitido. Emails do painel requerem plano Basic ou superior. Expiração fixa de 2 meses (parâmetro tempo é ignorado).

Exemplos de erro

400

INVALID_USERNAME

Nome de usuário deve ter pelo menos 3 caracteres

Validação do nome de usuário personalizado falhou. Deve ter entre 3 e 30 caracteres apenas com caracteres válidos.

409

EMAIL_IN_USE

Endereço de email "[email protected]" já está em uso

O nome de usuário personalizado já está em uso. Escolha um nome de usuário diferente.

400

DOMAIN_NOT_FOUND

Domínio "custom.domain" não está disponível. Deve ser um domínio personalizado verificado na sua conta ou um domínio público.

O domínio especificado não existe ou não está verificado. Verifique-o primeiro na sua conta.

400

DOMAIN_NOT_VERIFIED

Domínio personalizado "custom.domain" não está verificado. Status atual: pendente

O domínio existe mas ainda não está verificado. Complete a verificação do domínio primeiro.

429

DAILY_LIMIT_EXCEEDED

Limite diário excedido para emails de 1 hora

Você atingiu seu limite diário para este tipo de email

Requisição de exemplo

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

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

Documentação

Parâmetros

consulta

include_expired

Incluir emails expirados

Exemplo: true

⚠️ Deve ser "true" ou "false"

consulta

permanent_only

Mostrar apenas suas caixas permanentes salvas. Custa 2 créditos por solicitação.

Exemplo: true

⚠️ Deve ser "true" ou "false"

consulta

include_permanent

Incluir suas caixas permanentes salvas junto com as recentes. Custa 2 créditos por solicitação.

Exemplo: true

⚠️ Deve ser "true" ou "false"

consulta

limit

Número de emails para retornar

Exemplo: 50

⚠️ Máximo 100 emails

Exemplos de erro

402

INSUFFICIENT_CREDITS

Adicione créditos para listar caixas permanentes.

Retornado ao tentar listar caixas permanentes salvas mas a conta tem créditos insuficientes.

Requisição de exemplo

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

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

Documentação

Parâmetros

caminhoObrigatório

ID do email

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

⚠️ Deve ser um UUID válido

Exemplos de erro

404

EMAIL_NOT_FOUND

O email solicitado não foi encontrado ou expirou

ID do email é inválido ou email expirou

Requisição de exemplo

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

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

Documentação

Parâmetros

caminhoObrigatório

ID do email

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

⚠️ Deve ser um UUID válido

consulta

limit

Número de mensagens para retornar

Exemplo: 50

⚠️ Máximo 100 mensagens

consulta

offset

Número de mensagens para pular

Exemplo: 0

⚠️ Deve ser um inteiro não negativo

Exemplos de erro

404

EMAIL_NOT_FOUND

O email solicitado não foi encontrado ou expirou

ID do email é inválido ou email expirou

400

INVALID_LIMIT

Limite deve estar entre 1 e 100

Parâmetro limite está fora do intervalo válido

Requisição de exemplo

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

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

Documentação

Parâmetros

caminhoObrigatório

ID do email (formato UUID). Pode ser um ID de email API baseado em tempo ou um ID de email do painel criado com create_as_dashboard=true

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

⚠️ Deve ser um UUID válido

Exemplos de erro

404

EMAIL_NOT_FOUND

O email solicitado não foi encontrado ou expirou

O email não existe ou já foi excluído

Requisição de exemplo

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

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

Documentação

Parâmetros

consultaObrigatório

include_dashboard

Deve ser definido como "true" para acessar emails do painel. Isso ativa o recurso premium e cobra 2 créditos.

Exemplo: true

⚠️ Deve ser "true" - Usuários do nível gratuito receberão erro 403

consulta

include_expired

Incluir emails expirados na resposta (emails API e emails do painel)

Exemplo: false

consulta

limit

Número máximo de emails para retornar (máx: 100)

Exemplo: 50

⚠️ Deve estar entre 1 e 100

Exemplos de erro

403

TIER_RESTRICTED

Acesso a emails do painel requer um plano pago (Basic ou superior)

Este é um recurso premium. Usuários do nível gratuito não podem acessar emails do painel via API.

402

INSUFFICIENT_CREDITS

São necessários 2 créditos para listar emails do painel

Esta operação custa 2 créditos. Por favor, adicione mais créditos à sua conta.

Requisição de exemplo

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

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

Documentação

Parâmetros

caminhoObrigatório

ID do email do painel (formato UUID) - Copie isso do seu painel ou do endpoint list-dashboard-emails

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

⚠️ Deve ser um UUID válido dos seus emails do painel

consultaObrigatório

include_dashboard

Deve ser "true" para buscar emails do painel. Cobra 1 crédito.

Exemplo: true

Exemplos de erro

403

TIER_RESTRICTED

Recurso Premium

Acesso a emails do painel requer um plano pago

402

INSUFFICIENT_CREDITS

É necessário 1 crédito para acessar o email do painel

Esta operação custa 1 crédito

404

EMAIL_NOT_FOUND

Email não encontrado

O email solicitado não foi encontrado ou expirou

Requisição de exemplo

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

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

Documentação

Parâmetros

caminhoObrigatório

ID do email do painel - O UUID do email para o qual você deseja obter mensagens

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

⚠️ Deve ser um UUID válido dos seus emails do painel

consultaObrigatório

include_dashboard

Deve ser "true" para acessar mensagens do email do painel. Cobra 1 crédito.

Exemplo: true

consulta

limit

Número máximo de mensagens para retornar por página (máx: 100)

Exemplo: 20

⚠️ Deve estar entre 1 e 100

consulta

offset

Número de mensagens para pular para paginação (ex: offset=20 com limit=20 obtém página 2)

Exemplo: 0

⚠️ Deve ser um inteiro não negativo

Exemplos de erro

403

TIER_RESTRICTED

Recurso Premium

Acesso a emails do painel requer um plano pago

402

INSUFFICIENT_CREDITS

É necessário 1 crédito para acessar mensagens do email do painel

Esta operação custa 1 crédito

404

EMAIL_NOT_FOUND

Email não encontrado

O email solicitado não foi encontrado ou expirou

Requisição de exemplo

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

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

Documentação

Parâmetros

caminhoObrigatório

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

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

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

consultaObrigatório

include_dashboard

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

Exemplo: true

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

Exemplos de erro

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

Requisição de exemplo

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

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

Documentação

Parâmetros

caminhoObrigatório

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

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

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

consultaObrigatório

include_dashboard

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

Exemplo: true

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

corpoObrigatório

is_enabled

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

Exemplo: true

⚠️ Must be a boolean value

Exemplos de erro

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

Requisição de exemplo

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

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

Documentação

Parâmetros

consultaObrigatório

include_dashboard

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

Exemplo: true

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

corpoObrigatório

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.

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

Exemplos de erro

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.

Requisição de exemplo

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

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

Documentação

Parâmetros

consulta

create_as_dashboard

Defina como "true" para criar um email estilo painel armazenado no banco de dados com expiração fixa de 2 meses. Se omitido, cria um email API baseado em tempo na memória. Ambos suportam custom_username.

Exemplo: true

⚠️ ⚠️ Emails do painel custam 15 créditos. Expiração fixa de 2 meses (sem parâmetro tempo). Usuários do nível gratuito receberão erro 403. Omita este parâmetro para criar um email API baseado em tempo com opções de tempo personalizadas.

consulta

custom_username

Exemplo: john.doe

⚠️ ⚠️ Deve ter entre 3 e 30 caracteres. Não pode começar/terminar com caracteres especiais. Deve ser único em todos os seus emails. Se já estiver em uso, retorna 409 Conflict.

consulta

domain

Nome de domínio personalizado opcional para o endereço de email. Se não especificado, um domínio público aleatório será usado.

Exemplo: mail.yourdomain.com

⚠️ Deve ser um domínio verificado na sua conta

Exemplos de erro

403

TIER_RESTRICTED

Recurso Premium

Criação de emails do painel requer um plano pago

402

INSUFFICIENT_CREDITS

São necessários 15 créditos para criar um email do painel

Esta operação custa 15 créditos

400

INVALID_USERNAME

Nome de usuário deve ter pelo menos 3 caracteres

Validação do nome de usuário personalizado falhou. Deve ter entre 3 e 30 caracteres apenas com caracteres válidos.

409

EMAIL_IN_USE

Endereço de email "[email protected]" já está em uso

O nome de usuário personalizado já está em uso. Escolha um nome de usuário diferente.

400

INVALID_TIME_PARAMETER

Parâmetro de tempo inválido

Tempo deve ser um de: 10min, 1hour, 1day, permanent

Requisição de exemplo

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

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

Documentação

Exemplos de erro

401

UNAUTHORIZED

Chave API inválida ou ausente

Chave API é obrigatória e deve ser válida

Requisição de exemplo

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

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

Documentação

Exemplos de erro

401

UNAUTHORIZED

Chave API inválida ou ausente

Chave API é obrigatória e deve ser válida

Requisição de exemplo

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

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

Documentação

Exemplos de erro

401

UNAUTHORIZED

Chave API inválida ou ausente

Chave API é obrigatória e deve ser válida

Requisição de exemplo

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

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

Limite: 60 RPMHub da API

Testar API