Banger APIリファレンス

ワークスペースのプロダクト一覧

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataarray必須
• 各項目object
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• namestring必須
• slugstring必須
• kindstring必須

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null必須
• domainsarray必須
• 各項目string
• descriptionstring必須
• contextobject必須
• 追加プロパティ任意の値
• brandobject必須
• company_namestring

  maxLength: 160

• logo_urlstring

  アイコン: マーク単体。小さな表示（メールのフッター、スライドインフォーム）や、ワードマークがない場合のヘッダーに使います。

  maxLength: 2000

• wordmark_urlstring

  ワードマーク: デザインされた会社名。各メールの上部に単独で表示します。

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring必須

  deleting: 人による削除。delete_afterまでは復元でき、その後完全に削除されます。

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  deleting状態のプロダクトが完全に削除される日時。

  format: "date-time"

• is_defaultboolean必須
• route_readyboolean必須
• setuparray必須
• 各項目object
• keystring必須

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstring必須

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | null必須

  enum: "system", "person", "agent", null

• notestring必須
• updated_atstring | null必須

  format: "date-time"

• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products' \
  --header "Authorization: Bearer $BANGER_API_KEY"

プロダクトを作成

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject
• namestring必須

  minLength: 1 · maxLength: 160

• kindstring

  default: "product" · enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• 追加プロパティ任意の値
• domainsarray

  maxItems: 20

• 各項目string

  maxLength: 253

成功レスポンス 201

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• namestring必須
• slugstring必須
• kindstring必須

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null必須
• domainsarray必須
• 各項目string
• descriptionstring必須
• contextobject必須
• 追加プロパティ任意の値
• brandobject必須
• company_namestring

  maxLength: 160

• logo_urlstring

  アイコン: マーク単体。小さな表示（メールのフッター、スライドインフォーム）や、ワードマークがない場合のヘッダーに使います。

  maxLength: 2000

• wordmark_urlstring

  ワードマーク: デザインされた会社名。各メールの上部に単独で表示します。

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring必須

  deleting: 人による削除。delete_afterまでは復元でき、その後完全に削除されます。

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  deleting状態のプロダクトが完全に削除される日時。

  format: "date-time"

• is_defaultboolean必須
• route_readyboolean必須
• setuparray必須
• 各項目object
• keystring必須

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstring必須

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | null必須

  enum: "system", "person", "agent", null

• notestring必須
• updated_atstring | null必須

  format: "date-time"

• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "example",
  "kind": "product",
  "website_url": "example",
  "description": "example",
  "context": {},
  "domains": [
    "example"
  ]
}'

プロダクトを取得

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• namestring必須
• slugstring必須
• kindstring必須

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null必須
• domainsarray必須
• 各項目string
• descriptionstring必須
• contextobject必須
• 追加プロパティ任意の値
• brandobject必須
• company_namestring

  maxLength: 160

• logo_urlstring

  アイコン: マーク単体。小さな表示（メールのフッター、スライドインフォーム）や、ワードマークがない場合のヘッダーに使います。

  maxLength: 2000

• wordmark_urlstring

  ワードマーク: デザインされた会社名。各メールの上部に単独で表示します。

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring必須

  deleting: 人による削除。delete_afterまでは復元でき、その後完全に削除されます。

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  deleting状態のプロダクトが完全に削除される日時。

  format: "date-time"

• is_defaultboolean必須
• route_readyboolean必須
• setuparray必須
• 各項目object
• keystring必須

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstring必須

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | null必須

  enum: "system", "person", "agent", null

• notestring必須
• updated_atstring | null必須

  format: "date-time"

• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

プロダクトを更新

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• 追加プロパティ任意の値
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  アイコン: マーク単体。小さな表示（メールのフッター、スライドインフォーム）や、ワードマークがない場合のヘッダーに使います。

  maxLength: 2000

• wordmark_urlstring

  ワードマーク: デザインされた会社名。各メールの上部に単独で表示します。

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring

  enum: "active", "archived"

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• namestring必須
• slugstring必須
• kindstring必須

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null必須
• domainsarray必須
• 各項目string
• descriptionstring必須
• contextobject必須
• 追加プロパティ任意の値
• brandobject必須
• company_namestring

  maxLength: 160

• logo_urlstring

  アイコン: マーク単体。小さな表示（メールのフッター、スライドインフォーム）や、ワードマークがない場合のヘッダーに使います。

  maxLength: 2000

• wordmark_urlstring

  ワードマーク: デザインされた会社名。各メールの上部に単独で表示します。

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring必須

  deleting: 人による削除。delete_afterまでは復元でき、その後完全に削除されます。

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  deleting状態のプロダクトが完全に削除される日時。

  format: "date-time"

• is_defaultboolean必須
• route_readyboolean必須
• setuparray必須
• 各項目object
• keystring必須

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstring必須

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | null必須

  enum: "system", "person", "agent", null

• notestring必須
• updated_atstring | null必須

  format: "date-time"

• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

curlの例

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "example",
  "kind": "product",
  "website_url": "example",
  "description": "example",
  "context": {},
  "brand": {
    "company_name": "example",
    "logo_url": "example",
    "wordmark_url": "example",
    "website_url": "example",
    "primary_color": "example",
    "accent_color": "example",
    "background_color": "example",
    "surface_color": "example",
    "text_color": "example",
    "muted_text_color": "example",
    "heading_font_family": "example",
    "body_font_family": "example",
    "tone": "example",
    "footer_address": "example",
    "email_style": "example"
  },
  "status": "active"
}'

削除プレビューを確認してから、1つのプロダクト（アプリ内のプロジェクト）を削除します。すぐに利用停止（送信停止）となり、24時間は復元できます。その後Bangerが送信ドメインと所有する全行を削除します。ワークスペースの最後の有効なプロダクトは削除できません。ワークスペース管理者とログイン済みセッションが必要です。APIキーとOAuth認可は拒否されます。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• confirm_namestring必須

  プロダクトの正確な名前。

  minLength: 1 · maxLength: 160

• preview_tokenstring必須

  minLength: 64 · maxLength: 64

成功レスポンス 202

プロダクトは利用停止中で、事前に復元しなければdelete_afterに完全削除されます。冪等な再実行では同じ結果を返します。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• namestring必須
• statusstring必須

  enum: "deleting"

• delete_afterstring必須

  プロダクトの完全削除日時。それまでは復元できます。

  format: "date-time"

• next_product_idstring必須

  現在のワークスペースの既定プロダクト。

  format: "uuid"

• replayedboolean

curlの例

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "confirm_name": "example",
  "preview_token": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'

何も削除せず、1つのプロダクトと所有する全データの削除をプレビューします。ログイン済み、またはユーザー認可OAuth経由のワークスペース管理者が必要です。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

プロダクトの削除で削除・停止されるもの。

application/json

• valueobject
• dataobject必須
• productobject必須
• idstring必須

  format: "uuid"

• namestring必須
• is_defaultboolean必須
• next_default_product未指定必須

  既定プロダクトの削除時にワークスペースの既定となるプロダクト。

• oneOf 1null
• oneOf 2object
• idstring必須

  format: "uuid"

• namestring必須
• last_productboolean必須

  唯一の有効なプロダクトは削除できません。

• mailboxesarray必須
• 各項目object
• idstring必須

  format: "uuid"

• addressstring必須
• domainsarray必須

  復元期間終了後にBangerが削除する送信ドメイン。

• 各項目object
• idstring必須

  format: "uuid"

• domainstring必須
• journeysinteger必須
• broadcastsinteger必須
• signup_formsinteger必須
• contactsinteger必須
• api_keysinteger必須
• webhooksinteger必須
• pending_sendsinteger必須
• impactarray必須
• 各項目string
• preview_tokenstring必須

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/deletion-preview' \
  --header "Authorization: Bearer $BANGER_API_KEY"

削除済みプロダクトをdelete_afterより前に復元します。メールボックス、ジャーニー、登録フォーム、Webhook、連携は再度有効になります。一斉配信は一時停止のままです。ログイン済み、またはユーザー認可OAuth経由のワークスペース管理者が必要です。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

プロダクトが再び有効になりました。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• namestring必須
• statusstring必須

  enum: "active"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/restore' \
  --header "Authorization: Bearer $BANGER_API_KEY"

プロダクト設定項目を更新

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject
• statusstring必須

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring

  default: "person" · enum: "system", "person", "agent"

• notestring

  maxLength: 1000

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataobject必須
• keystring必須

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstring必須

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | null必須

  enum: "system", "person", "agent", null

• notestring必須
• updated_atstring | null必須

  format: "date-time"

curlの例

curl --request PUT --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/setup/{key}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "status": "todo",
  "completion_source": "person",
  "note": "example"
}'

ドメインをプロダクトに関連付け

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject
• domainstring必須

  minLength: 3 · maxLength: 253

成功レスポンス 201

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• namestring必須
• slugstring必須
• kindstring必須

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null必須
• domainsarray必須
• 各項目string
• descriptionstring必須
• contextobject必須
• 追加プロパティ任意の値
• brandobject必須
• company_namestring

  maxLength: 160

• logo_urlstring

  アイコン: マーク単体。小さな表示（メールのフッター、スライドインフォーム）や、ワードマークがない場合のヘッダーに使います。

  maxLength: 2000

• wordmark_urlstring

  ワードマーク: デザインされた会社名。各メールの上部に単独で表示します。

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring必須

  deleting: 人による削除。delete_afterまでは復元でき、その後完全に削除されます。

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  deleting状態のプロダクトが完全に削除される日時。

  format: "date-time"

• is_defaultboolean必須
• route_readyboolean必須
• setuparray必須
• 各項目object
• keystring必須

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstring必須

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | null必須

  enum: "system", "person", "agent", null

• notestring必須
• updated_atstring | null必須

  format: "date-time"

• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/domains' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "domain": "example"
}'

listMailboxes

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

実行者に表示されるメールボックス。

application/json

• valueobject
• dataarray必須
• 各項目object
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• product_idstring | null

  メールボックスが属するプロダクト（プロジェクト）。クライアントはこれでメールボックスをまとめ、Webアプリへのリンクを作成します。

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring必須

  format: "email"

• display_namestring必須
• providerstring必須

  enum: "gmail", "smtp"

• statusstring必須

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring必須

  enum: "domain", "starter"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes' \
  --header "Authorization: Bearer $BANGER_API_KEY"

ワークスペースの送信ドメインにBangerネイティブの業務用メールボックスを作成します。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• domain_idstring必須

  format: "uuid"

• local_partstring必須

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

成功レスポンス 200

ネイティブメールボックス作成の冪等な再実行。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• product_idstring | null

  メールボックスが属するプロダクト（プロジェクト）。クライアントはこれでメールボックスをまとめ、Webアプリへのリンクを作成します。

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring必須

  format: "email"

• display_namestring必須
• providerstring必須

  enum: "gmail", "smtp"

• statusstring必須

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring必須

  enum: "domain", "starter"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "domain_id": "00000000-0000-4000-8000-000000000001",
  "local_part": "example",
  "display_name": "example"
}'

メールボックスの完全削除と依存する送信フローをプレビューします。ワークスペース管理者とプロダクトスコープが必要です。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

何も削除せずに、対象のメールボックスと現在の削除影響を確認します。

application/json

• valueobject
• dataobject必須
• mailboxobject必須
• idstring必須

  format: "uuid"

• addressstring必須
• providerstring必須
• domain_idstring | null必須

  format: "uuid"

• provider_connection_idstring | null必須

  format: "uuid"

• messagesinteger必須
• draftsinteger必須
• pending_sendsinteger必須
• broadcastsarray必須
• 各項目object
• idstring必須

  format: "uuid"

• namestring必須
• statusstring必須
• journeysarray必須
• 各項目object
• idstring必須

  format: "uuid"

• namestring必須
• statusstring必須
• signup_formsarray必須
• 各項目object
• idstring必須

  format: "uuid"

• namestring必須
• statusstring必須
• impactarray必須
• 各項目string
• preview_tokenstring必須

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}/deletion-preview' \
  --header "Authorization: Bearer $BANGER_API_KEY"

1つのBangerメールボックスからのメールで受信者に表示する送信者名（"Name <address>"）を設定します。GmailメールボックスはGmailで設定した名前を維持します。ワークスペース管理者が必要です。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• display_namestring必須

  1行。空の場合はアドレスのみで送信します。

  maxLength: 200

成功レスポンス 200

送信者名付きのメールボックス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• product_idstring | null

  メールボックスが属するプロダクト（プロジェクト）。クライアントはこれでメールボックスをまとめ、Webアプリへのリンクを作成します。

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring必須

  format: "email"

• display_namestring必須
• providerstring必須

  enum: "gmail", "smtp"

• statusstring必須

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring必須

  enum: "domain", "starter"

curlの例

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "display_name": "example"
}'

ドメインと他のメールボックスを残し、1つのメールボックスを完全削除します。ワークスペース管理者とプロダクトスコープが必要です。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• confirm_addressstring必須

  minLength: 3 · maxLength: 320

• preview_tokenstring必須

  minLength: 64 · maxLength: 64

成功レスポンス 200

削除済み、または冪等な再実行。保存ファイルは完全削除のキューに入ります。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• addressstring必須
• deletedboolean必須
• replayedboolean

curlの例

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "confirm_address": "example",
  "preview_token": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'

同じプロダクトのホスト型受信トレイとワークスペース登録者への送信に限定したホスト型メールボックスを作成します。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• create_newboolean

  最初のメールボックスを再開する代わりに、追加のホスト型メールボックスを作成します。

• local_partstring

  @bangermail.comの前の名前。省略するとquiet-maple-harborのような単語の名前が付与されます。

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

成功レスポンス 200

スターターID作成の冪等な再実行。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• product_idstring | null

  メールボックスが属するプロダクト（プロジェクト）。クライアントはこれでメールボックスをまとめ、Webアプリへのリンクを作成します。

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring必須

  format: "email"

• display_namestring必須
• providerstring必須

  enum: "gmail", "smtp"

• statusstring必須

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring必須

  enum: "domain", "starter"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/starter' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "create_new": true,
  "local_part": "example",
  "display_name": "example"
}'

resumeSendingのセルフサービス再開ルールに従い、1つのメールボックスの送信者評価による一時停止を解除します。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• acknowledge_recipient_complaintboolean必須

  const: true

• reasonstring

  送信再開の理由。監査ログに記録します。

  maxLength: 500

成功レスポンス 200

メールボックスは再有効化済み、または以前のリクエスト成功によりすでに有効です。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• workspace_idstring必須

  format: "uuid"

• product_idstring | null

  メールボックスが属するプロダクト（プロジェクト）。クライアントはこれでメールボックスをまとめ、Webアプリへのリンクを作成します。

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring必須

  format: "email"

• display_namestring必須
• providerstring必須

  enum: "gmail", "smtp"

• statusstring必須

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring必須

  enum: "domain", "starter"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}/reactivate' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "acknowledge_recipient_complaint": true,
  "reason": "example"
}'

listDrafts

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataarray必須
• 各項目object
• idstring必須

  format: "uuid"

• mailbox_idstring必須

  format: "uuid"

• thread_idstring | null必須

  format: "uuid"

• versioninteger必須
• toarray必須
• 各項目object
• emailstring必須
• namestring
• ccarray必須
• 各項目object
• emailstring必須
• namestring
• bccarray必須
• 各項目object
• emailstring必須
• namestring
• subjectstring必須
• body_textstring必須
• statusstring必須
• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• attachmentsarray必須
• 各項目object
• idstring必須

  format: "uuid"

• filenamestring必須
• content_typestring必須
• size_bytesinteger必須
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts?mailbox_id=00000000-0000-4000-8000-000000000001' \
  --header "Authorization: Bearer $BANGER_API_KEY"

createDraft

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• mailbox_idstring必須

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• 各項目object
• namestring
• emailstring必須

  format: "email"

• ccarray

  maxItems: 500

• 各項目object
• namestring
• emailstring必須

  format: "email"

• bccarray

  maxItems: 500

• 各項目object
• namestring
• emailstring必須

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

成功レスポンス 201

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• mailbox_idstring必須

  format: "uuid"

• thread_idstring | null必須

  format: "uuid"

• versioninteger必須
• toarray必須
• 各項目object
• emailstring必須
• namestring
• ccarray必須
• 各項目object
• emailstring必須
• namestring
• bccarray必須
• 各項目object
• emailstring必須
• namestring
• subjectstring必須
• body_textstring必須
• statusstring必須
• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• attachmentsarray必須
• 各項目object
• idstring必須

  format: "uuid"

• filenamestring必須
• content_typestring必須
• size_bytesinteger必須
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "thread_id": "00000000-0000-4000-8000-000000000001",
  "to": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "body_text": "example",
  "body_html": "example"
}'

getDraft

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

正規の到達率実績、健全性、インシデント。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• mailbox_idstring必須

  format: "uuid"

• thread_idstring | null必須

  format: "uuid"

• versioninteger必須
• toarray必須
• 各項目object
• emailstring必須
• namestring
• ccarray必須
• 各項目object
• emailstring必須
• namestring
• bccarray必須
• 各項目object
• emailstring必須
• namestring
• subjectstring必須
• body_textstring必須
• statusstring必須
• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• attachmentsarray必須
• 各項目object
• idstring必須

  format: "uuid"

• filenamestring必須
• content_typestring必須
• size_bytesinteger必須
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

updateDraft

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• value未指定
• allOf 1object

  追加プロパティなし

• mailbox_idstring必須

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• 各項目object
• namestring
• emailstring必須

  format: "email"

• ccarray

  maxItems: 500

• 各項目object
• namestring
• emailstring必須

  format: "email"

• bccarray

  maxItems: 500

• 各項目object
• namestring
• emailstring必須

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versioninteger必須

  minimum: 1

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• mailbox_idstring必須

  format: "uuid"

• thread_idstring | null必須

  format: "uuid"

• versioninteger必須
• toarray必須
• 各項目object
• emailstring必須
• namestring
• ccarray必須
• 各項目object
• emailstring必須
• namestring
• bccarray必須
• 各項目object
• emailstring必須
• namestring
• subjectstring必須
• body_textstring必須
• statusstring必須
• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• attachmentsarray必須
• 各項目object
• idstring必須

  format: "uuid"

• filenamestring必須
• content_typestring必須
• size_bytesinteger必須
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curlの例

curl --request PUT --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "thread_id": "00000000-0000-4000-8000-000000000001",
  "to": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "body_text": "example",
  "body_html": "example",
  "version": 1
}'

deleteDraft

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 204

下書きと参照オブジェクトは削除予定です。

レスポンス本文なし。

curlの例

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

sendDraft

呼び出し元がアクセスできるメールボックスから下書きを送信します。送信に承認が必要な呼び出し元には、代わりに承認待ちを返します。下書きを直接送信できる人が判断します。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 202

送信はキュー内、または承認待ちです。

application/json

• valueobject
• data未指定必須
• oneOf 1object
• idstring必須

  format: "uuid"

• typestring必須
• statusstring必須

  enum: "accepted", "executing", "succeeded", "failed"

• workspace_revisioninteger必須

  format: "int64"

• created_atstring必須

  format: "date-time"

• oneOf 2object

  追加プロパティなし

• approvalobject必須
• idstring必須

  format: "uuid"

• requested_by_actor_idstring必須
• action_kindstring必須
• summarystring必須
• capability_scopesarray必須
• 各項目string
• resource_scopeobject必須
• 追加プロパティarray
• 各項目string

  さらに深い入れ子は省略

• payloadobject必須
• 追加プロパティ任意の値
• payload_sha256string必須

  pattern: "^[0-9a-f]{64}$"

• statusstring必須

  enum: "pending", "approved", "rejected", "cancelled", "expired"

• missedboolean必須
• expires_atstring必須

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  追加プロパティなし

• dispositionstring必須

  enum: "automatic", "human_required"

• recipient_countinteger | null必須

  minimum: 0

• reasonsarray必須
• 各項目string

  さらに深い入れ子は省略

• checksarray必須
• 各項目string

  さらに深い入れ子は省略

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/send' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx'

uploadDraftAttachment

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

成功レスポンス 201

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• filenamestring必須
• content_typestring必須
• size_bytesinteger必須
• sha256string
• created_atstring

  format: "date-time"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/attachments' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'X-Banger-Filename: example' \
  --header 'Content-Type: application/octet-stream' \
  --data-binary @request-body

deleteDraftAttachment

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 204

添付ファイルはバージョンを考慮したB2削除の予定に入っています。

レスポンス本文なし。

curlの例

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/attachments/{attachmentId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

下書きのHTML本文を取得

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

下書きのHTML。

text/html

• valuestring

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/html' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listSendIntents

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

最近の正規送信とプロバイダーの状態。

application/json

• valueobject
• dataarray必須
• 各項目object

  追加プロパティなし

• idstring必須

  format: "uuid"

• statusstring必須

  enum: "accepted", "scheduled", "queued", "executing", "partially_succeeded", "succeeded", "failed", "canceled"

• traffic_classstring必須

  enum: "mailbox", "product", "broadcast"

• recipient_countinteger必須

  minimum: 1

• provider_keystring必須
• provider_statestring必須

  enum: "pending", "leased", "submitted", "accepted", "ambiguous", "reconciling", "succeeded", "failed", "canceled"

• provider_message_idstring | null
• error_codestring | null
• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/send-intents?limit=50' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getSendIntent

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

正規の非同期送信状態。

application/json

• valueobject
• dataobject必須

  追加プロパティなし

• idstring必須

  format: "uuid"

• statusstring必須

  enum: "accepted", "scheduled", "queued", "executing", "partially_succeeded", "succeeded", "failed", "canceled"

• traffic_classstring必須

  enum: "mailbox", "product", "broadcast"

• recipient_countinteger必須

  minimum: 1

• provider_keystring必須
• provider_statestring必須

  enum: "pending", "leased", "submitted", "accepted", "ambiguous", "reconciling", "succeeded", "failed", "canceled"

• provider_message_idstring | null
• error_codestring | null
• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/send-intents/{sendIntentId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listTransactionalSends

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataarray必須
• 各項目object
• idstring必須

  format: "uuid"

• mailbox_idstring | null必須

  format: "uuid"

• command_idstring | null必須

  format: "uuid"

• statusstring必須
• command_statusstring | null必須
• subjectstring
• recipientsarray
• 各項目object
• emailstring必須
• namestring
• recipient_countinteger必須
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• 追加プロパティinteger
• provider_message_idstring | null
• language未指定

  このメールの送信言語。未翻訳の場合はnull。

• anyOf 1object

  受信者がメールを受け取った言語。翻訳済み（管理コンテンツ）メールにのみ存在します。

• localestring必須

  メールの執筆言語のBCP 47タグ。

• requested_localestring

  別の言語で送信された過去の送信にのみ存在します。受信者が受け取るべきだった言語です。

• fallback_reasonstring

  enum: "translation_missing", "translation_pending", "translation_review_required", "translation_failed", "translation_timeout"

• anyOf 2null
• journeyobject | null

  このメールを送信したジャーニーのステップと登録。他の送信ではnull。

• journey_idstring必須

  format: "uuid"

• step_idstring必須

  format: "uuid"

• enrollment_idstring必須

  format: "uuid"

• experimentobject | null

  このメールの実験バリアント。該当しない場合はnull。

• experiment_idstring必須

  format: "uuid"

• variant_keystring必須
• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• completed_atstring | null必須

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• 追加プロパティ任意の値
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• 各項目object
• emailstring必須
• namestring
• headersobject
• 追加プロパティstring
• tagsarray
• 各項目object
• namestring必須
• valuestring必須

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends?limit=200' \
  --header "Authorization: Bearer $BANGER_API_KEY"

createTransactionalSend

ジャーニー送信は1受信者です。Toは任意のRecipientInput形式（"a@example.com"、"Pat <a@example.com>"、{ email, name }、または1要素のリスト）で1受信者を受け付け、CcとBccは空でなければなりません。reply_toの既定はジャーニーのメールボックスです（空のリストも既定を意味します）。プロダクトメールには正確に1つ必要です。新しいAPIジャーニーは管理されたソースコンテンツを既定とし、旧コードジャーニーは完全コンテンツ送信を維持します。拒否（4xx）では受信者用の凍結データは残らず、新しい冪等キーで修正して呼び出すと送信されます。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject
• mailbox_idstring必須

  format: "uuid"

• to未指定必須

  to、cc、bcc、reply_toの受信者: アドレス（"a@example.com"または"Pat <a@example.com>"）、{ email, name }オブジェクト、または両方を混在させたリスト。Bangerはメールを小文字にした{ email, name }オブジェクトとして保存します。冪等ハッシュは送信時の本文を対象とするため、同じ形式で再試行してください。

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstring必須

  format: "email"

• oneOf 3array

  maxItems: 500

• 各項目未指定
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstring必須

  format: "email"

• ccarray

  maxItems: 0

• 各項目object
• namestring
• emailstring必須

  format: "email"

• bccarray

  maxItems: 0

• 各項目object
• namestring
• emailstring必須

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  この日時を過ぎた延期ジャーニー送信を破棄します。元のリクエストから最大7日です。

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_to未指定

  to、cc、bcc、reply_toの受信者: アドレス（"a@example.com"または"Pat <a@example.com>"）、{ email, name }オブジェクト、または両方を混在させたリスト。Bangerはメールを小文字にした{ email, name }オブジェクトとして保存します。冪等ハッシュは送信時の本文を対象とするため、同じ形式で再試行してください。

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstring必須

  format: "email"

• oneOf 3array

  maxItems: 500

• 各項目未指定
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstring必須

  format: "email"

• headersobject
• 追加プロパティstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• 各項目object

  追加プロパティなし

• namestring必須

  minLength: 1 · maxLength: 256

• valuestring必須

  minLength: 1 · maxLength: 256

成功レスポンス 202

成功レスポンス。

application/json

• valueobject
• dataobject必須
• action_kindstring必須

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstring必須

  配信によるsent/queued状態、または凍結リクエストの状態: deferred（ポリシーによる予約または翻訳待ち）、processing（送信中）、discarded。

• replayedboolean
• journey未指定必須
• anyOf 1object
• journey_idstring必須

  format: "uuid"

• enrollment_idstring必須

  format: "uuid"

• step_idstring必須

  format: "uuid"

• step_positioninteger必須
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarray必須
• 各項目string
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "to": "example",
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "expires_at": "2026-01-01T00:00:00Z",
  "expires_after_seconds": 1,
  "body_text": "example",
  "body_html": "example",
  "reply_to": "example",
  "headers": {},
  "tags": [
    {
      "name": "example",
      "value": "example"
    }
  ]
}'

getTransactionalSend

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• mailbox_idstring | null必須

  format: "uuid"

• command_idstring | null必須

  format: "uuid"

• statusstring必須
• command_statusstring | null必須
• subjectstring
• recipientsarray
• 各項目object
• emailstring必須
• namestring
• recipient_countinteger必須
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• 追加プロパティinteger
• provider_message_idstring | null
• language未指定

  このメールの送信言語。未翻訳の場合はnull。

• anyOf 1object

  受信者がメールを受け取った言語。翻訳済み（管理コンテンツ）メールにのみ存在します。

• localestring必須

  メールの執筆言語のBCP 47タグ。

• requested_localestring

  別の言語で送信された過去の送信にのみ存在します。受信者が受け取るべきだった言語です。

• fallback_reasonstring

  enum: "translation_missing", "translation_pending", "translation_review_required", "translation_failed", "translation_timeout"

• anyOf 2null
• journeyobject | null

  このメールを送信したジャーニーのステップと登録。他の送信ではnull。

• journey_idstring必須

  format: "uuid"

• step_idstring必須

  format: "uuid"

• enrollment_idstring必須

  format: "uuid"

• experimentobject | null

  このメールの実験バリアント。該当しない場合はnull。

• experiment_idstring必須

  format: "uuid"

• variant_keystring必須
• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• completed_atstring | null必須

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• 追加プロパティ任意の値
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• 各項目object
• emailstring必須
• namestring
• headersobject
• 追加プロパティstring
• tagsarray
• 各項目object
• namestring必須
• valuestring必須

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends/{transactionalSendId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listTransactionalSendTimeline

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

受付、プロバイダー試行、受信者イベントの順序付きタイムライン。

application/json

• valueobject
• dataarray必須
• 各項目object
• occurred_atstring必須

  format: "date-time"

• event_typestring必須
• labelstring必須
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends/{transactionalSendId}/timeline' \
  --header "Authorization: Bearer $BANGER_API_KEY"

retryTransactionalSend

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 202

成功レスポンス。

application/json

• valueobject
• dataobject必須
• action_kindstring必須

  enum: "transactional.send"

• idstring必須

  format: "uuid"

• send_intent_idstring必須

  format: "uuid"

• provider_attempt_idstring必須

  format: "uuid"

• statusstring必須
• replayedboolean必須

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends/{transactionalSendId}/retry' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx'

listThreads

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

キーセットでページ分割したワークスペースのスレッド。

application/json

• valueobject
• dataarray必須
• 各項目object
• idstring必須

  format: "uuid"

• mailbox_idstring必須

  format: "uuid"

• subjectstring必須
• snippetstring必須
• last_message_atstring必須

  format: "date-time"

• message_countinteger必須
• unread_countinteger必須
• is_archivedboolean必須
• is_trashboolean必須
• is_spamboolean必須
• is_starredboolean必須
• is_sentboolean必須
• has_attachmentsboolean必須
• labelsarray必須
• 各項目string
• participantsarray
• 各項目object
• namestring
• emailstring必須

  format: "email"

• pageobject必須
• next_cursorstring
• has_moreboolean必須

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/threads?cursor=example&limit=50&mailbox_id=00000000-0000-4000-8000-000000000001&label_id=00000000-0000-4000-8000-000000000001&view=inbox' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getThread

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

スレッドと順序付きメッセージ。

application/json

• valueobject
• data未指定必須
• allOf 1object
• idstring必須

  format: "uuid"

• mailbox_idstring必須

  format: "uuid"

• subjectstring必須
• snippetstring必須
• last_message_atstring必須

  format: "date-time"

• message_countinteger必須
• unread_countinteger必須
• is_archivedboolean必須
• is_trashboolean必須
• is_spamboolean必須
• is_starredboolean必須
• is_sentboolean必須
• has_attachmentsboolean必須
• labelsarray必須
• 各項目string
• participantsarray
• 各項目object
• namestring
• emailstring必須

  format: "email"

• allOf 2object
• messagesarray必須
• 各項目object
• idstring必須

  format: "uuid"

• mailbox_idstring必須

  format: "uuid"

• thread_idstring必須

  format: "uuid"

• sent_atstring必須

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  受信専用エイリアスのルーティング前にSMTPエッジで大文字小文字を正規化した、元のSMTPエンベロープ受信者。古いメッセージやSMTP以外のソースでは空です。表示されるTo/Ccヘッダーとは独立しています。

• 各項目string

  format: "email"

  さらに深い入れ子は省略

• fromobject必須
• namestring

  さらに深い入れ子は省略

• emailstring必須

  format: "email"

  さらに深い入れ子は省略

• toarray必須
• 各項目object

  さらに深い入れ子は省略

• ccarray
• 各項目object

  さらに深い入れ子は省略

• reply_toarray
• 各項目object

  さらに深い入れ子は省略

• is_sentboolean

  エイリアスを含め、このメールボックスから送信されたメッセージかどうか。

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstring必須

  format: "uuid"

  さらに深い入れ子は省略

• sourcestring必須

  enum: "gateway", "transactional", "marketing", "mailbox", "agent"

  さらに深い入れ子は省略

• source_idstring

  format: "uuid"

  さらに深い入れ子は省略

• traffic_classstring必須

  enum: "transactional", "marketing", "mailbox"

  さらに深い入れ子は省略

• kindstring必須

  enum: "campaign", "sequence", "transactional", "mailbox", "agent"

  さらに深い入れ子は省略

• namestring

  さらに深い入れ子は省略

• has_attachmentsboolean必須
• attachmentsarray
• 各項目object

  さらに深い入れ子は省略

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/threads/{threadId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getMessageHtml

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

認証付きでサンドボックス制約のあるHTMLメッセージ本文。

text/html

• valuestring

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/messages/{messageId}/html' \
  --header "Authorization: Bearer $BANGER_API_KEY"

downloadAttachment

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

認証付き添付ファイルストリーム。

application/octet-stream

• valuestring

  format: "binary"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/attachments/{attachmentId}/content' \
  --header "Authorization: Bearer $BANGER_API_KEY"

searchMail

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

ワークスペース全体の検索結果。

application/json

• valueobject
• dataarray必須
• 各項目object
• idstring必須

  format: "uuid"

• mailbox_idstring必須

  format: "uuid"

• subjectstring必須
• snippetstring必須
• last_message_atstring必須

  format: "date-time"

• message_countinteger必須
• unread_countinteger必須
• is_archivedboolean必須
• is_trashboolean必須
• is_spamboolean必須
• is_starredboolean必須
• is_sentboolean必須
• has_attachmentsboolean必須
• labelsarray必須
• 各項目string
• participantsarray
• 各項目object
• namestring
• emailstring必須

  format: "email"

• pageobject必須
• next_cursorstring
• has_moreboolean必須

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/search?q=example&cursor=example&limit=50&mailbox_id=00000000-0000-4000-8000-000000000001' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listContacts

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataarray必須
• 各項目object
• idstring必須

  format: "uuid"

• emailstring必須

  format: "email"

• display_namestring | null必須
• attributesobject必須
• 追加プロパティ任意の値
• statusstring必須

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• pageobject必須
• next_cursorstring
• has_moreboolean必須

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts?cursor=example&limit=50&q=example' \
  --header "Authorization: Bearer $BANGER_API_KEY"

upsertContact

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• emailstring必須

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring必須

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• attributesobject
• 追加プロパティ任意の値
• consent_confirmedboolean

  アドレスの新規購読登録時に必須。

成功レスポンス 201

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• emailstring必須

  format: "email"

• display_namestring | null必須
• attributesobject必須
• 追加プロパティ任意の値
• statusstring必須

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "email": "person@example.com",
  "display_name": "example",
  "status": "subscribed",
  "attributes": {},
  "consent_confirmed": true
}'

getContact

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• emailstring必須

  format: "email"

• display_namestring | null必須
• attributesobject必須
• 追加プロパティ任意の値
• statusstring必須

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• suppressedboolean必須
• suppression_reasonstring | null必須
• sourcesarray必須
• 各項目object
• kindstring必須
• referencestring必須
• connection_idstring | null必須

  format: "uuid"

• metadataobject必須
• 追加プロパティ任意の値
• first_seen_atstring必須

  format: "date-time"

• last_seen_atstring必須

  format: "date-time"

• listsarray必須
• 各項目object
• idstring必須

  format: "uuid"

• namestring必須
• subscription_statusstring必須
• consent_evidencearray必須
• 各項目object
• kindstring必須
• referencestring必須
• connection_idstring | null必須

  format: "uuid"

• metadataobject必須
• 追加プロパティ任意の値
• first_seen_atstring必須

  format: "date-time"

• last_seen_atstring必須

  format: "date-time"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

deleteContact

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 204

連絡先を削除しました。

レスポンス本文なし。

curlの例

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listContactImports

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文

契約にリクエスト本文の指定はありません。

成功レスポンス 200

成功レスポンス。

application/json

• valueobject
• dataarray必須
• 各項目object
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• 各項目string
• consent_confirmedboolean
• consent_confirmed_atstring | null

  format: "date-time"

• processed_rowsinteger
• attempt_countinteger
• last_error_codestring | null
• created_atstring

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curlの例

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/imports' \
  --header "Authorization: Bearer $BANGER_API_KEY"

importContacts

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject
• filenamestring必須

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  インポートする行に購読登録がある場合は必須。

• rowsarray必須

  minItems: 1 · maxItems: 5000

• 各項目object
• emailstring必須

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• attributesobject
• 追加プロパティ任意の値

成功レスポンス 201

成功レスポンス。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• statusstring必須

  enum: "queued"

• total_rowsinteger必須
• imported_rowsinteger必須
• invalid_rowsinteger必須
• list_idstring | null必須

  format: "uuid"

curlの例

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/imports' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "filename": "example",
  "list_id": "00000000-0000-4000-8000-000000000001",
  "consent_confirmed": true,
  "rows": [
    {
      "email": "person@example.com",
      "display_name": "example",
      "status": "subscribed",
      "attributes": {}
    }
  ]
}'

購読や同意を変更せずに型付き属性を統合

contacts:writeとcontacts:readが必要です。既存の連絡先のみ更新します。省略属性は維持し、明示的なfalseは保存、nullはフィールドを削除します。検証済みのソース事実を指定してください。データの欠落はfalseではありません。購読、送信抑止、ID、ソース履歴は変更しません。

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• attributesobject必須
• 追加プロパティ任意の値

成功レスポンス 200

現在の連絡先の読み戻し。この変更が適用済みの場合、replayedはtrueです。

application/json

• valueobject
• dataobject必須
• idstring必須

  format: "uuid"

• attributesobject必須
• 追加プロパティ任意の値
• statusstring必須

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• replayedboolean必須
• 追加プロパティ任意の値

curlの例

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}/attributes' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'X-Banger-Product-Id: 00000000-0000-4000-8000-000000000001' \
  --header 'Idempotency-Key: example' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "attributes": {}
}'

upsertProductContact

認証: BearerワークスペースAPIキー。

パラメーター

リクエスト本文 必須

application/json

• valueobject

  追加プロパティなし

• emailstring必須

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• 追加プロパティ任意の値
• statusstring必須

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• consent_evidenceobject

  追加プロパティなし

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

成功レスポンス 200

正規の読み戻し、または冪等な受領情報。プロバイダー受付はsentです。deliveredには配信イベントが必要で、受信トレイへの到達を証明するものではありません。

application/json

• valueobject
• data未指定必須
• allOf 1object
• idstring必須

  format: "uuid"

• emailstring必須

  format: "email"

• display_namestring | null必須
• attributesobject必須
• 追加プロパティ任意の値
• statusstring必須

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstring必須

  format: "date-time"

• updated_atstring必須

  format: "date-time"

• suppressedboolean必須
• suppression_reasonstring | null必須
• sourcesarray必須
• 各項目object
• kindstring必須
• referencestring必須
• connection_idstring | null必須

  format: "uuid"

• metadataobject必須
• 追加プロパティ任意の値
• first_seen_atstring必須

  format: "date-time"

• last_seen_atstring必須

  format: "date-time"

• listsarray必須
• 各項目object
• idstring必須

  format: "uuid"

• namestring必須
• subscription_statusstring必須
• consent_evidencearray必須
• 各項目object
• kindstring必須
• referencestring必須
• connection_idstring | null必須

  format: "uuid"

• metadataobject必須
• 追加プロパティ任意の値
• first_seen_atstring必須

  format: "date-time"

• last_seen_atstring必須

  format: "date-time"

• allOf 2object
• replayedboolean必須