BlueAI メール データ構造
メール API で返却される主要オブジェクトのフィールド定義です。
|
ID 形式
各リソースは prefix 付き public ID（例: deal_..., inv_..., form_..., ak_...）を利用します。
全プロダクト共通の ID 規約Message object
送信済みメッセージを表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | メッセージ ID |
object | string | 必須 | オブジェクト種別（`mail.message`） |
organization_id | string | 必須 | 組織 ID |
to | string | 必須 | 宛先メールアドレス |
subject | string | 必須 | 件名 |
status | "queued" | "sent" | "delivered" | "bounced" | "failed" | 必須 | 配信ステータス |
sent_at | string | null | 任意 | 送信日時 (ISO 8601) |
created_at | string | 必須 | 作成日時 (ISO 8601) |
{
"id": "msg_01JQ3KXYZ",
"object": "mail.message",
"organization_id": "org_01HZXYZ",
"to": "user@example.com",
"subject": "Your invoice is ready",
"status": "delivered",
"sent_at": "2026-02-20T10:00:00Z",
"created_at": "2026-02-20T09:55:00Z"
}Contact object
メール配信先の連絡先を表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 連絡先 ID |
object | string | 必須 | オブジェクト種別（`mail.contact`） |
organization_id | string | 必須 | 組織 ID |
email | string | 必須 | メールアドレス |
name | string | null | 任意 | 氏名 |
is_unsubscribed | boolean | 必須 | 配信停止フラグ |
created_at | string | 必須 | 作成日時 (ISO 8601) |
updated_at | string | 必須 | 更新日時 (ISO 8601) |
{
"id": "mc_01JQ3KDEF",
"object": "mail.contact",
"organization_id": "org_01HZXYZ",
"email": "tanaka@example.com",
"name": "Tanaka Taro",
"is_unsubscribed": false,
"created_at": "2026-01-15T09:00:00Z",
"updated_at": "2026-02-18T11:00:00Z"
}Campaign object
メールキャンペーンを表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | キャンペーン ID |
object | string | 必須 | オブジェクト種別（`mail.campaign`） |
organization_id | string | 必須 | 組織 ID |
name | string | 必須 | キャンペーン名 |
subject | string | 必須 | 件名 |
status | "draft" | "scheduled" | "sending" | "sent" | "cancelled" | 必須 | ステータス（draft: 下書き、scheduled: 予定、sending: 送信中、sent: 送信済、cancelled: キャンセル） |
list_id | string | 必須 | 配信リスト ID |
sent_at | string | null | 任意 | 送信日時 |
created_at | string | 必須 | 作成日時 (ISO 8601) |
updated_at | string | 必須 | 更新日時 (ISO 8601) |
{
"id": "camp_01JQ3KGHI",
"object": "mail.campaign",
"organization_id": "org_01HZXYZ",
"name": "February Newsletter",
"subject": "What's new in February",
"status": "sent",
"list_id": "list_01JQ3KJKL",
"sent_at": "2026-02-15T09:00:00Z",
"created_at": "2026-02-10T14:00:00Z",
"updated_at": "2026-02-15T09:00:00Z"
}