BlueAI キャンペーン（Campaigns）
メールキャンペーンの作成・送信・統計取得を行います。
|
エンドポイント
| GET | /api/v1/mail/campaigns | キャンペーン一覧を取得 |
| POST | /api/v1/mail/campaigns | キャンペーンを作成 |
| GET | /api/v1/mail/campaigns/{id} | キャンペーンを取得 |
| PATCH | /api/v1/mail/campaigns/{id} | キャンペーンを更新 |
| DELETE | /api/v1/mail/campaigns/{id} | キャンペーンを削除 |
| POST | /api/v1/mail/campaigns/{id}/send | キャンペーンを送信 |
| GET | /api/v1/mail/campaigns/{id}/stats | キャンペーン統計を取得 |
GET
/api/v1/mail/campaignsキャンペーン一覧を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
クエリパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
search | string | 任意 | キャンペーン名で検索 |
status | string | 任意 | ステータスで絞り込み（draft / scheduled / sent） |
limit | integer | 任意 | 取得件数（デフォルト: 20, 最大: 100） |
offset | integer | 任意 | 取得開始位置（デフォルト: 0） |
コード例
curl "https://api.blueai.jp/api/v1/mail/campaigns" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/mail/campaignsキャンペーンを作成
認証が必要です— セッション Cookie または Bearer トークンを含めてください
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
name | string | 必須 | キャンペーン名 |
subject | string | 必須 | メール件名 |
sender_name | string | 任意 | 差出人名 |
sender_email | string | 任意 | 差出人メールアドレス |
reply_to | string | 任意 | 返信先メールアドレス |
list_id | string | 必須 | 配信先リスト ID |
html_body | string | 任意 | HTML 本文 |
text_body | string | 任意 | テキスト本文 |
コード例
curl -X POST "https://api.blueai.jp/api/v1/mail/campaigns" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/mail/campaigns/{id}キャンペーンを取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | キャンペーン ID |
コード例
curl "https://api.blueai.jp/api/v1/mail/campaigns/camp_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"PATCH
/api/v1/mail/campaigns/{id}キャンペーンを更新
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | キャンペーン ID |
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
name | string | 任意 | キャンペーン名 |
subject | string | 任意 | メール件名 |
sender_name | string | 任意 | 差出人名 |
sender_email | string | 任意 | 差出人メールアドレス |
reply_to | string | 任意 | 返信先メールアドレス |
list_id | string | 任意 | 配信先リスト ID |
html_body | string | 任意 | HTML 本文 |
text_body | string | 任意 | テキスト本文 |
コード例
curl -X PATCH "https://api.blueai.jp/api/v1/mail/campaigns/camp_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/mail/campaigns/{id}キャンペーンを削除
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | キャンペーン ID |
コード例
curl -X DELETE "https://api.blueai.jp/api/v1/mail/campaigns/camp_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/mail/campaigns/{id}/sendキャンペーンを送信
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | キャンペーン ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/mail/campaigns/camp_123e4567e89b12d3a456426614174000/send" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/mail/campaigns/{id}/statsキャンペーン統計を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | キャンペーン ID |
コード例
curl "https://api.blueai.jp/api/v1/mail/campaigns/camp_123e4567e89b12d3a456426614174000/stats" \
-H "Cookie: better-auth.session_token=<token>"