Temp Mail API Documentation - Boomlify

Complete API reference for temporary email service integration

POST`/api/v1/emails/create`

Создать новый временный адрес электронной почты Теперь поддерживает опциональный параметр custom_username для создания писем с персонализированными адресами.

Parameters:

custom_username (query, optional): Опциональное пользовательское имя для адреса электронной почты. Может содержать буквы, цифры, точки, дефисы и подчеркивания. Должно быть от 3 до 30 символов. Если не указано, будет сгенерировано случайное имя пользователя. - Example: john.doe
time (query, optional): Время истечения - Example: permanent
domain (query, optional): Опциональный пользовательский домен для адреса электронной почты. Должен быть верифицированным доменом в вашем аккаунте (используйте эндпоинт custom_domains для верификации). Если не указан, будет использован случайный публичный домен. - Example: mail.yourdomain.com
create_as_dashboard (query, optional): 💎 Премиум функция - Установите "true" для создания письма в стиле дашборда, хранящегося в базе данных с фиксированным сроком действия 2 месяца, вместо временного API-письма. Пропустите или установите "false" для временных писем (по умолчанию). Письма дашборда стоят 15 кредитов. Пользователи бесплатного тарифа получат ошибку 403. - Example: true

Error Responses:

INVALID_USERNAME (400): Проверка пользовательского имени не пройдена. Должно быть от 3 до 30 символов только с допустимыми символами.
EMAIL_IN_USE (409): Пользовательское имя уже занято. Выберите другое имя пользователя.
DOMAIN_NOT_FOUND (400): Указанный домен не существует или не верифицирован. Сначала верифицируйте его в вашем аккаунте.
DOMAIN_NOT_VERIFIED (400): Домен существует, но еще не верифицирован. Сначала завершите верификацию домена.
DAILY_LIMIT_EXCEEDED (429): Вы достигли дневного лимита для этого типа писем

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

GET`/api/v1/emails`

Показать все ваши активные временные письма

Parameters:

include_expired (query, optional): Включить истекшие письма - Example: true
permanent_only (query, optional): Показать только ваши сохраненные постоянные почтовые ящики. Стоит 2 кредита за запрос. - Example: true
include_permanent (query, optional): Включить ваши сохраненные постоянные почтовые ящики вместе с недавними. Стоит 2 кредита за запрос. - Example: true
limit (query, optional): Количество возвращаемых писем - Example: 50

Error Responses:

INSUFFICIENT_CREDITS (402): Возвращается при попытке перечислить сохраненные постоянные почтовые ящики, но на счету недостаточно кредитов.

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

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

Получить детали конкретного письма

Parameters:

id (path, required): ID письма - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): ID письма недействителен или письмо истекло

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

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

Получить сообщения для конкретного письма

Parameters:

id (path, required): ID письма - Example: 550e8400-e29b-41d4-a716-446655440000
limit (query, optional): Количество возвращаемых сообщений - Example: 50
offset (query, optional): Количество пропускаемых сообщений - Example: 0

Error Responses:

EMAIL_NOT_FOUND (404): ID письма недействителен или письмо истекло
INVALID_LIMIT (400): Параметр лимита находится вне допустимого диапазона

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

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

Удалить письмо по ID. Поддерживает как временные API-письма (в памяти, немедленно удаляются), так и письма дашборда (хранятся в базе данных, немедленно удаляются). Возвращает 404, если письмо не найдено или уже удалено.

Parameters:

id (path, required): ID письма (формат UUID). Может быть ID временного API-письма или ID письма дашборда, созданного с create_as_dashboard=true - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): Письмо не существует или уже удалено

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

GET`/api/v1/emails`

💎 Премиум функция - Показать все письма, включая письма, созданные в дашборде. Этот эндпоинт объединяет письма, созданные через API, с вашими письмами дашборда в одном ответе. Стоит 2 кредита за запрос. Требуется тариф Basic или выше.

Parameters:

include_dashboard (query, required): Должно быть установлено в "true" для доступа к письмам дашборда. Это включает премиум функцию и списывает 2 кредита. - Example: true
include_expired (query, optional): Включить истекшие письма в ответ (как API, так и письма дашборда) - Example: false
limit (query, optional): Максимальное количество возвращаемых писем (макс: 100) - Example: 50

Error Responses:

TIER_RESTRICTED (403): Это премиум функция. Пользователи бесплатного тарифа не могут получить доступ к письмам дашборда через API.
INSUFFICIENT_CREDITS (402): Эта операция стоит 2 кредита. Пожалуйста, добавьте больше кредитов на ваш аккаунт.

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

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

💎 Премиум функция - Получить подробную информацию о конкретном письме дашборда. Если письмо не найдено в хранилище API, оно ищет ваши письма дашборда. Стоит 1 кредит за запрос. Требуется тариф Basic или выше.

Parameters:

id (path, required): ID письма дашборда (формат UUID) - Скопируйте это из вашего дашборда или из эндпоинта list-dashboard-emails - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Должно быть "true" для поиска писем дашборда. Списывает 1 кредит. - Example: true

Error Responses:

TIER_RESTRICTED (403): Доступ к письмам дашборда требует платного тарифа
INSUFFICIENT_CREDITS (402): Эта операция стоит 1 кредит
EMAIL_NOT_FOUND (404): Запрашиваемое письмо не найдено или истекло

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

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

💎 Премиум функция - Получить все полученные сообщения для письма дашборда с поддержкой пагинации. Использует кэш для быстрого времени отклика. Стоит 1 кредит за запрос. Требуется тариф Basic или выше.

Parameters:

id (path, required): ID письма дашборда - UUID письма, для которого вы хотите получить сообщения - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Должно быть "true" для доступа к сообщениям письма дашборда. Списывает 1 кредит. - Example: true
limit (query, optional): Максимальное количество возвращаемых сообщений на страницу (макс: 100) - Example: 20
offset (query, optional): Количество пропускаемых сообщений для пагинации (например, offset=20 с limit=20 получает страницу 2) - Example: 0

Error Responses:

TIER_RESTRICTED (403): Доступ к письмам дашборда требует платного тарифа
INSUFFICIENT_CREDITS (402): Эта операция стоит 1 кредит
EMAIL_NOT_FOUND (404): Запрашиваемое письмо не найдено или истекло

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`

💎 Премиум функция - Создать новое письмо с опциональным пользовательским именем. Письма дашборда (create_as_dashboard=true) хранятся в БД с фиксированным сроком действия 2 месяца и стоят 15 кредитов. Временные API-письма поддерживают пользовательские опции времени (10min, 1hour, 1day, permanent). Оба поддерживают custom_username. Требуется тариф Basic или выше.

Parameters:

create_as_dashboard (query, optional): Установите "true" для создания письма в стиле дашборда, хранящегося в базе данных с фиксированным сроком действия 2 месяца. Если пропущено, создает временное API-письмо в памяти. Оба поддерживают custom_username. - Example: true
custom_username (query, optional): Опциональное пользовательское имя для адреса электронной почты. Может содержать буквы, цифры, точки, дефисы и подчеркивания. Должно быть от 3 до 30 символов. Если не указано, будет сгенерировано случайное имя пользователя. - Example: john.doe
domain (query, optional): Опциональное пользовательское имя домена для адреса электронной почты. Если не указано, будет использован случайный публичный домен. - Example: mail.yourdomain.com

Error Responses:

TIER_RESTRICTED (403): Создание письма дашборда требует платного тарифа
INSUFFICIENT_CREDITS (402): Эта операция стоит 15 кредитов
INVALID_USERNAME (400): Проверка пользовательского имени не пройдена. Должно быть от 3 до 30 символов только с допустимыми символами.
EMAIL_IN_USE (409): Пользовательское имя уже занято. Выберите другое имя пользователя.
INVALID_TIME_PARAMETER (400): Время должно быть одним из: 10min, 1hour, 1day, permanent

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

GET`/api/v1/account/usage`

Получить статистику использования API

Error Responses:

UNAUTHORIZED (401): API ключ является обязательным и должен быть действительным

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

GET`/api/v1/account/info`

Получить информацию о вашем аккаунте

Error Responses:

UNAUTHORIZED (401): API ключ является обязательным и должен быть действительным

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

GET`/api/v1/account/credits`

Получить подробную информацию о балансе кредитов и использовании

Error Responses:

UNAUTHORIZED (401): API ключ является обязательным и должен быть действительным

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

Центр документации и тестирования API Temp Mail

Читайте документацию, тестируйте эндпойнты и копируйте код — всё на одной странице.

Базовый URL:

https://v1.boomlify.com

Быстрый старт

Почта

💎 Dashboard API (Premium)

Аккаунт

POST /api/v1/emails/create

Требуется авторизацияОграничение по запросам

Документация

Параметры

запрос

custom_username

Опциональное пользовательское имя для адреса электронной почты. Может содержать буквы, цифры, точки, дефисы и подчеркивания. Должно быть от 3 до 30 символов. Если не указано, будет сгенерировано случайное имя пользователя.

Пример: john.doe

⚠️ ⚠️ Должно быть от 3 до 30 символов. Не может начинаться/заканчиваться специальными символами. Должно быть уникальным. Возвращает 409, если уже занято.

запрос

time

Время истечения

Пример: permanent

⚠️ Должно быть одним из: 10min, 1hour, 1day, permanent

запрос

domain

Опциональный пользовательский домен для адреса электронной почты. Должен быть верифицированным доменом в вашем аккаунте (используйте эндпоинт custom_domains для верификации). Если не указан, будет использован случайный публичный домен.

Пример: mail.yourdomain.com

⚠️ ⚠️ Должен быть верифицированным пользовательским доменом или публичным доменом. Возвращает 400, если недоступен.

запрос

create_as_dashboard

💎 Премиум функция - Установите "true" для создания письма в стиле дашборда, хранящегося в базе данных с фиксированным сроком действия 2 месяца, вместо временного API-письма. Пропустите или установите "false" для временных писем (по умолчанию). Письма дашборда стоят 15 кредитов. Пользователи бесплатного тарифа получат ошибку 403.

Пример: true

⚠️ ⚠️ Должно быть "true" или пропущено. Письма дашборда требуют тарифа Basic или выше. Фиксированный срок действия 2 месяца (параметр времени игнорируется).

Примеры ошибок

400

INVALID_USERNAME

Имя пользователя должно содержать не менее 3 символов

Проверка пользовательского имени не пройдена. Должно быть от 3 до 30 символов только с допустимыми символами.

409

EMAIL_IN_USE

Адрес электронной почты "[email protected]" уже используется

Пользовательское имя уже занято. Выберите другое имя пользователя.

400

DOMAIN_NOT_FOUND

Домен "custom.domain" недоступен. Он должен быть либо верифицированным пользовательским доменом в вашем аккаунте, либо публичным доменом.

Указанный домен не существует или не верифицирован. Сначала верифицируйте его в вашем аккаунте.

400

DOMAIN_NOT_VERIFIED

Пользовательский домен "custom.domain" не верифицирован. Текущий статус: ожидает

Домен существует, но еще не верифицирован. Сначала завершите верификацию домена.

429

DAILY_LIMIT_EXCEEDED

Превышен дневной лимит для 1-часовых писем

Вы достигли дневного лимита для этого типа писем

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

запрос

include_expired

Включить истекшие письма

Пример: true

⚠️ Должно быть "true" или "false"

запрос

permanent_only

Показать только ваши сохраненные постоянные почтовые ящики. Стоит 2 кредита за запрос.

Пример: true

⚠️ Должно быть "true" или "false"

запрос

include_permanent

Включить ваши сохраненные постоянные почтовые ящики вместе с недавними. Стоит 2 кредита за запрос.

Пример: true

⚠️ Должно быть "true" или "false"

запрос

limit

Количество возвращаемых писем

Пример: 50

⚠️ Максимум 100 писем

Примеры ошибок

402

INSUFFICIENT_CREDITS

Добавьте кредиты для списка постоянных почтовых ящиков.

Возвращается при попытке перечислить сохраненные постоянные почтовые ящики, но на счету недостаточно кредитов.

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

путьОбязательно

ID письма

Пример: 550e8400-e29b-41d4-a716-446655440000

⚠️ Должен быть действительным UUID

Примеры ошибок

404

EMAIL_NOT_FOUND

Запрашиваемое письмо не найдено или истекло

ID письма недействителен или письмо истекло

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

путьОбязательно

ID письма

Пример: 550e8400-e29b-41d4-a716-446655440000

⚠️ Должен быть действительным UUID

запрос

limit

Количество возвращаемых сообщений

Пример: 50

⚠️ Максимум 100 сообщений

запрос

offset

Количество пропускаемых сообщений

Пример: 0

⚠️ Должно быть неотрицательным целым числом

Примеры ошибок

404

EMAIL_NOT_FOUND

Запрашиваемое письмо не найдено или истекло

ID письма недействителен или письмо истекло

400

INVALID_LIMIT

Лимит должен быть между 1 и 100

Параметр лимита находится вне допустимого диапазона

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

путьОбязательно

ID письма (формат UUID). Может быть ID временного API-письма или ID письма дашборда, созданного с create_as_dashboard=true

Пример: 550e8400-e29b-41d4-a716-446655440000

⚠️ Должен быть действительным UUID

Примеры ошибок

404

EMAIL_NOT_FOUND

Запрашиваемое письмо не найдено или истекло

Письмо не существует или уже удалено

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

запросОбязательно

include_dashboard

Должно быть установлено в "true" для доступа к письмам дашборда. Это включает премиум функцию и списывает 2 кредита.

Пример: true

⚠️ Должно быть "true" - пользователи бесплатного тарифа получат ошибку 403

запрос

include_expired

Включить истекшие письма в ответ (как API, так и письма дашборда)

Пример: false

запрос

limit

Максимальное количество возвращаемых писем (макс: 100)

Пример: 50

⚠️ Должно быть от 1 до 100

Примеры ошибок

403

TIER_RESTRICTED

Доступ к письмам дашборда требует платного тарифа (Basic или выше)

Это премиум функция. Пользователи бесплатного тарифа не могут получить доступ к письмам дашборда через API.

402

INSUFFICIENT_CREDITS

Требуется 2 кредита для списка писем дашборда

Эта операция стоит 2 кредита. Пожалуйста, добавьте больше кредитов на ваш аккаунт.

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

путьОбязательно

ID письма дашборда (формат UUID) - Скопируйте это из вашего дашборда или из эндпоинта list-dashboard-emails

Пример: 550e8400-e29b-41d4-a716-446655440000

⚠️ Должен быть действительным UUID из ваших писем дашборда

запросОбязательно

include_dashboard

Должно быть "true" для поиска писем дашборда. Списывает 1 кредит.

Пример: true

Примеры ошибок

403

TIER_RESTRICTED

Премиум функция

Доступ к письмам дашборда требует платного тарифа

402

INSUFFICIENT_CREDITS

Требуется 1 кредит для доступа к письму дашборда

Эта операция стоит 1 кредит

404

EMAIL_NOT_FOUND

Письмо не найдено

Запрашиваемое письмо не найдено или истекло

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

путьОбязательно

ID письма дашборда - UUID письма, для которого вы хотите получить сообщения

Пример: 550e8400-e29b-41d4-a716-446655440000

⚠️ Должен быть действительным UUID из ваших писем дашборда

запросОбязательно

include_dashboard

Должно быть "true" для доступа к сообщениям письма дашборда. Списывает 1 кредит.

Пример: true

запрос

limit

Максимальное количество возвращаемых сообщений на страницу (макс: 100)

Пример: 20

⚠️ Должно быть от 1 до 100

запрос

offset

Количество пропускаемых сообщений для пагинации (например, offset=20 с limit=20 получает страницу 2)

Пример: 0

⚠️ Должно быть неотрицательным целым числом

Примеры ошибок

403

TIER_RESTRICTED

Премиум функция

Доступ к письмам дашборда требует платного тарифа

402

INSUFFICIENT_CREDITS

Требуется 1 кредит для доступа к сообщениям письма дашборда

Эта операция стоит 1 кредит

404

EMAIL_NOT_FOUND

Письмо не найдено

Запрашиваемое письмо не найдено или истекло

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

путьОбязательно

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

Пример: 550e8400-e29b-41d4-a716-446655440000

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

запросОбязательно

include_dashboard

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

Пример: true

⚠️ Must be "true" - Free tier users will receive a 403 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

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

путьОбязательно

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

Пример: 550e8400-e29b-41d4-a716-446655440000

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

запросОбязательно

include_dashboard

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

Пример: true

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

телоОбязательно

is_enabled

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

Пример: true

⚠️ Must be a boolean value

Примеры ошибок

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

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

запросОбязательно

include_dashboard

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

Пример: true

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

телоОбязательно

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.

Пример: ["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.

Примеры ошибок

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.

Пример запроса

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

Фрагменты кода

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

Документация

Параметры

запрос

create_as_dashboard

Установите "true" для создания письма в стиле дашборда, хранящегося в базе данных с фиксированным сроком действия 2 месяца. Если пропущено, создает временное API-письмо в памяти. Оба поддерживают custom_username.

Пример: true

⚠️ ⚠️ Письма дашборда стоят 15 кредитов. Фиксированный срок действия 2 месяца (параметр времени отсутствует). Пользователи бесплатного тарифа получат ошибку 403. Пропустите этот параметр для создания временного API-письма с пользовательскими опциями времени.

запрос

custom_username

Пример: john.doe

⚠️ ⚠️ Должно быть от 3 до 30 символов. Не может начинаться/заканчиваться специальными символами. Должно быть уникальным среди всех ваших писем. Если уже занято, возвращает 409 Conflict.

запрос

domain

Опциональное пользовательское имя домена для адреса электронной почты. Если не указано, будет использован случайный публичный домен.

Пример: mail.yourdomain.com

⚠️ Должен быть верифицированным доменом в вашем аккаунте

Примеры ошибок

403

TIER_RESTRICTED

Премиум функция

Создание письма дашборда требует платного тарифа

402

INSUFFICIENT_CREDITS

Требуется 15 кредитов для создания письма дашборда

Эта операция стоит 15 кредитов

400

INVALID_USERNAME

Имя пользователя должно содержать не менее 3 символов

Проверка пользовательского имени не пройдена. Должно быть от 3 до 30 символов только с допустимыми символами.

409

EMAIL_IN_USE

Адрес электронной почты "[email protected]" уже используется

Пользовательское имя уже занято. Выберите другое имя пользователя.

400

INVALID_TIME_PARAMETER

Недействительный параметр времени

Время должно быть одним из: 10min, 1hour, 1day, permanent

Пример запроса

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

Фрагменты кода

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

Документация

Примеры ошибок

401

UNAUTHORIZED

Недействительный или отсутствующий API ключ

API ключ является обязательным и должен быть действительным

Пример запроса

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

Фрагменты кода

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

Документация

Примеры ошибок

401

UNAUTHORIZED

Недействительный или отсутствующий API ключ

API ключ является обязательным и должен быть действительным

Пример запроса

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

Фрагменты кода

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

Документация

Примеры ошибок

401

UNAUTHORIZED

Недействительный или отсутствующий API ключ

API ключ является обязательным и должен быть действительным

Пример запроса

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

Фрагменты кода

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

Конструктор запросов

POST

Путь

https://v1.boomlify.com/api/v1/emails/create

API‑токен

Сохранять токенСохраняйте только на доверенных устройствах

Параметры

custom_username

time

Время истечения

⚠️ Должно быть одним из: 10min, 1hour, 1day, permanent

domain

create_as_dashboard

Тело запроса

Лимит: 60 RPMAPI‑Хаб

Тестировать API