必要な権限: campaigns
GET
/api/v1/campaigns
キャンペーン一覧を取得します。
Query Parameters
| Parameter | Type | Description |
|---|---|---|
status |
string | draft, scheduled, sending, sent |
limit |
integer | 結果数（デフォルト: 20） |
offset |
integer | ページネーションオフセット |
Response
{
"success": true,
"data": {
"campaigns": [
{
"id": "campaign-uuid-123",
"name": "January Newsletter",
"subject": "New Year Updates",
"status": "sent",
"stats": {
"sent": 1000,
"opened": 350,
"clicked": 120
},
"sent_at": "2026-01-01T10:00:00Z"
}
],
"total": 50
}
}
POST
/api/v1/campaigns
新しいキャンペーンを作成します。
Request Body
{
"name": "January Newsletter",
"subject": "New Year Updates from MailPass",
"list_id": "list-uuid-123",
"content": "<html>...</html>",
"from_email": "newsletter@example.com", // optional
"from_name": "MailPass Team", // optional
"reply_to": "support@example.com", // optional
"scheduled_at": "2026-01-15T09:00:00Z" // optional
}Response
{
"success": true,
"data": {
"id": "campaign-uuid-456",
"name": "January Newsletter",
"status": "draft",
"created_at": "2026-01-10T12:00:00Z"
}
}
GET
/api/v1/campaigns/{id}
キャンペーンの詳細情報を取得します。
Response
{
"success": true,
"data": {
"id": "campaign-uuid-123",
"name": "January Newsletter",
"subject": "New Year Updates",
"status": "sent",
"content": "<html>...</html>",
"stats": {
"total_sent": 1000,
"total_delivered": 985,
"total_opened": 350,
"unique_opens": 320,
"total_clicked": 150,
"unique_clicks": 120,
"total_bounced": 15,
"total_unsubscribed": 5,
"open_rate": 32.49,
"click_rate": 37.5
},
"sent_at": "2026-01-01T10:00:00Z",
"completed_at": "2026-01-01T10:15:00Z"
}
}
POST
/api/v1/campaigns/{id}/send
キャンペーンを即時送信します。
Response
{
"success": true,
"data": {
"id": "campaign-uuid-123",
"status": "sending",
"started_at": "2026-01-10T12:00:00Z"
}
}
GET
/api/v1/campaigns/{id}/stats
キャンペーン統計を取得します。
Response
{
"success": true,
"data": {
"campaign_id": "campaign-uuid-123",
"total_sent": 1000,
"total_delivered": 985,
"total_opened": 350,
"unique_opens": 320,
"total_clicked": 150,
"unique_clicks": 120,
"total_bounced": 15,
"total_unsubscribed": 5,
"open_rate": 32.49,
"click_rate": 37.5,
"top_links": [
{"url": "https://example.com/offer", "clicks": 80},
{"url": "https://example.com/blog", "clicks": 45}
]
}
}