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): 💎 プレミアム機能 - データベースに保存され、固定の2ヶ月の有効期限を持つダッシュボードスタイルのメールを作成するには「true」に設定します。時間ベースの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形式）。時間ベースのAPIメールIDまたはcreate_as_dashboard=trueで作成されたダッシュボードメールIDにすることができます - 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クレジットかかります。ベーシックプラン以上が必要です。

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クレジットかかります。ベーシックプラン以上が必要です。

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クレジットかかります。ベーシックプラン以上が必要です。

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ヶ月の有効期限でDBに保存され、15クレジットかかります。時間ベースのAPIメールは、カスタム時間オプション（10min, 1hour, 1day, permanent）をサポートします。両方ともcustom_usernameをサポートします。ベーシックプラン以上が必要です。

Parameters:

create_as_dashboard (query, optional): 固定の2ヶ月の有効期限でデータベースに保存されるダッシュボードスタイルのメールを作成するには「true」に設定します。省略した場合、メモリ内に時間ベースの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

Temp Mail API ドキュメント & テストハブ

ドキュメントを読み、エンドポイントをテストし、コードをコピー — すべて1ページで。

ベース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

💎 プレミアム機能 - データベースに保存され、固定の2ヶ月の有効期限を持つダッシュボードスタイルのメールを作成するには「true」に設定します。時間ベースのAPIメールの代わりに使用します。省略するか「false」に設定すると、時間ベースのメール（デフォルト）が作成されます。ダッシュボードメールは15クレジットかかります。無料ユーザーは403エラーを受け取ります。

例: true

⚠️ ⚠️ 「true」であるか省略する必要があります。ダッシュボードメールにはベーシックプラン以上が必要です。固定の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形式）。時間ベースのAPIメールIDまたはcreate_as_dashboard=trueで作成されたダッシュボードメールIDにすることができます

例: 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

ダッシュボードメールアクセスには有料プラン（ベーシック以上）が必要です

これはプレミアム機能です。無料ユーザーは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

固定の2ヶ月の有効期限でデータベースに保存されるダッシュボードスタイルのメールを作成するには「true」に設定します。省略した場合、メモリ内に時間ベースの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

⚠️ ⚠️ 認証済みのカスタムドメインまたはパブリックドメインである必要があります。利用できない場合、400を返します。

create_as_dashboard

リクエスト本文

上限: 60 RPMAPI ハブ

API をテスト