メインコンテンツへ
BlueAI
BlueAIBlueAI API
JAEN
ホーム/メール/シナリオ

シナリオ（Scenarios）

ステップメール等のシナリオ配信の作成・管理・有効化を行います。

|

エンドポイント

GET/api/v1/mail/scenariosシナリオ一覧を取得
POST/api/v1/mail/scenariosシナリオを作成
GET/api/v1/mail/scenarios/{id}シナリオを取得
PATCH/api/v1/mail/scenarios/{id}シナリオを更新
DELETE/api/v1/mail/scenarios/{id}シナリオを削除
POST/api/v1/mail/scenarios/{id}/activateシナリオを有効化
POST/api/v1/mail/scenarios/{id}/pauseシナリオを一時停止
GET/api/v1/mail/scenarios

シナリオ一覧を取得

認証が必要です— セッション Cookie または Bearer トークンを含めてください

クエリパラメータ

名前型必須説明
search
string任意シナリオ名で検索
status
string任意ステータスで絞り込み（draft / active / paused）
limit
integer任意取得件数（デフォルト: 20, 最大: 100）
offset
integer任意取得開始位置（デフォルト: 0）

コード例

curl "https://api.blueai.jp/api/v1/mail/scenarios" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/mail/scenarios

シナリオを作成

認証が必要です— セッション Cookie または Bearer トークンを含めてください

リクエストボディ

名前型必須説明
name
string必須シナリオ名
description
string任意説明
list_id
string任意対象リスト ID

コード例

curl -X POST "https://api.blueai.jp/api/v1/mail/scenarios" \
  -H "Cookie: better-auth.session_token=<token>"
GET/api/v1/mail/scenarios/{id}

シナリオを取得

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string任意シナリオ ID

コード例

curl "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"
PATCH/api/v1/mail/scenarios/{id}

シナリオを更新

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string任意シナリオ ID

リクエストボディ

名前型必須説明
name
string任意シナリオ名
description
string任意説明
list_id
string任意対象リスト ID

コード例

curl -X PATCH "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"
DELETE/api/v1/mail/scenarios/{id}

シナリオを削除

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string任意シナリオ ID

コード例

curl -X DELETE "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/mail/scenarios/{id}/activate

シナリオを有効化

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string任意シナリオ ID

コード例

curl -X POST "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000/activate" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/mail/scenarios/{id}/pause

シナリオを一時停止

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前型必須説明
id
string任意シナリオ ID

コード例

curl -X POST "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000/pause" \
  -H "Cookie: better-auth.session_token=<token>"