BlueAI Scenarios
Create, manage, and activate scenario-based email delivery such as drip campaigns.
|
Endpoints
| GET | /api/v1/mail/scenarios | List scenarios |
| POST | /api/v1/mail/scenarios | Create a scenario |
| GET | /api/v1/mail/scenarios/{id} | Get a scenario |
| PATCH | /api/v1/mail/scenarios/{id} | Update a scenario |
| DELETE | /api/v1/mail/scenarios/{id} | Delete a scenario |
| POST | /api/v1/mail/scenarios/{id}/activate | Activate a scenario |
| POST | /api/v1/mail/scenarios/{id}/pause | Pause a scenario |
GET
/api/v1/mail/scenariosList scenarios
Authentication required— Include session cookie or Bearer token
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | Optional | Search by scenario name |
status | string | Optional | Filter by status (draft / active / paused) |
limit | integer | Optional | Number of items to return (default: 20, max: 100) |
offset | integer | Optional | Offset for pagination (default: 0) |
Code Examples
curl "https://api.blueai.jp/api/v1/mail/scenarios" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/mail/scenariosCreate a scenario
Authentication required— Include session cookie or Bearer token
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Required | Scenario name |
description | string | Optional | Description |
list_id | string | Optional | Target list ID |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/mail/scenarios" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/mail/scenarios/{id}Get a scenario
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Scenario ID |
Code Examples
curl "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"PATCH
/api/v1/mail/scenarios/{id}Update a scenario
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Scenario ID |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Optional | Scenario name |
description | string | Optional | Description |
list_id | string | Optional | Target list ID |
Code Examples
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}Delete a scenario
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Scenario ID |
Code Examples
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}/activateActivate a scenario
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Scenario ID |
Code Examples
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}/pausePause a scenario
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Scenario ID |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/mail/scenarios/scn_123e4567e89b12d3a456426614174000/pause" \
-H "Cookie: better-auth.session_token=<token>"