BlueAI リスト（Lists）
配信リストの作成・管理およびメンバーの追加・削除を行います。
|
エンドポイント
| GET | /api/v1/mail/lists | リスト一覧を取得 |
| POST | /api/v1/mail/lists | リストを作成 |
| GET | /api/v1/mail/lists/{id} | リストを取得 |
| DELETE | /api/v1/mail/lists/{id} | リストを削除 |
| GET | /api/v1/mail/lists/{id}/members | リストメンバー一覧を取得 |
| POST | /api/v1/mail/lists/{id}/members | リストにメンバーを追加 |
| DELETE | /api/v1/mail/lists/{id}/members/{contactId} | リストからメンバーを削除 |
GET
/api/v1/mail/listsリスト一覧を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
クエリパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
search | string | 任意 | リスト名で検索 |
limit | integer | 任意 | 取得件数（デフォルト: 20, 最大: 100） |
offset | integer | 任意 | 取得開始位置（デフォルト: 0） |
コード例
curl "https://api.blueai.jp/api/v1/mail/lists" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/mail/listsリストを作成
認証が必要です— セッション Cookie または Bearer トークンを含めてください
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
name | string | 必須 | リスト名 |
description | string | 任意 | 説明 |
コード例
curl -X POST "https://api.blueai.jp/api/v1/mail/lists" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/mail/lists/{id}リストを取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | リスト ID |
コード例
curl "https://api.blueai.jp/api/v1/mail/lists/list_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/mail/lists/{id}リストを削除
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | リスト ID |
コード例
curl -X DELETE "https://api.blueai.jp/api/v1/mail/lists/list_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/mail/lists/{id}/membersリストメンバー一覧を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | リスト ID |
クエリパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | 任意 | 取得件数（デフォルト: 20, 最大: 100） |
offset | integer | 任意 | 取得開始位置（デフォルト: 0） |
コード例
curl "https://api.blueai.jp/api/v1/mail/lists/list_123e4567e89b12d3a456426614174000/members" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/mail/lists/{id}/membersリストにメンバーを追加
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | リスト ID |
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
contact_id | string | 必須 | 連絡先 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/mail/lists/list_123e4567e89b12d3a456426614174000/members" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/mail/lists/{id}/members/{contactId}リストからメンバーを削除
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | リスト ID |
contactId | string | 任意 | 連絡先 ID |
コード例
curl -X DELETE "https://api.blueai.jp/api/v1/mail/lists/list_123e4567e89b12d3a456426614174000/members/cont_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"