シナリオステップ(Scenario Steps)
シナリオ内の個別ステップ(メール送信・待機等)の追加・更新・削除を行います。
|
エンドポイント
| POST | /api/v1/mail/scenarios/{id}/steps | ステップを追加 |
| PATCH | /api/v1/mail/scenarios/{id}/steps/{stepId} | ステップを更新 |
| DELETE | /api/v1/mail/scenarios/{id}/steps/{stepId} | ステップを削除 |
POST
/api/v1/mail/scenarios/{id}/stepsステップを追加
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | シナリオ ID |
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
type | string | 必須 | ステップ種別(send_email / wait) |
subject | string | 任意 | メール件名(send_email 時) |
html_body | string | 任意 | HTML 本文(send_email 時) |
text_body | string | 任意 | テキスト本文(send_email 時) |
wait_days | integer | 任意 | 待機日数(wait 時) |
position | integer | 任意 | ステップ順序 |
コード例
curl -X POST "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000/steps" \
-H "Cookie: better-auth.session_token=<token>"PATCH
/api/v1/mail/scenarios/{id}/steps/{stepId}ステップを更新
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | シナリオ ID |
stepId | string | 任意 | ステップ ID |
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
subject | string | 任意 | メール件名 |
html_body | string | 任意 | HTML 本文 |
text_body | string | 任意 | テキスト本文 |
wait_days | integer | 任意 | 待機日数 |
position | integer | 任意 | ステップ順序 |
コード例
curl -X PATCH "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000/steps/step_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/mail/scenarios/{id}/steps/{stepId}ステップを削除
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | シナリオ ID |
stepId | string | 任意 | ステップ ID |
コード例
curl -X DELETE "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000/steps/step_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"