メール リファレンス

メールの送信・ドキュメントメール送信・Webhook 受信を行います。

• POST/api/v1/mail/send— メールを送信
• POST/api/v1/mail/send-document— ドキュメントメールを送信
• POST/api/v1/mail/webhooks/sendgrid— SendGrid Webhook を受信

送信済みメッセージの履歴を取得します。

• GET/api/v1/mail/messages— 送信履歴一覧を取得

メール配信先の連絡先の管理・インポートを行います。

• GET/api/v1/mail/contacts— 連絡先一覧を取得
• POST/api/v1/mail/contacts— 連絡先を作成
• GET/api/v1/mail/contacts/{id}— 連絡先を取得
• PATCH/api/v1/mail/contacts/{id}— 連絡先を更新
• DELETE/api/v1/mail/contacts/{id}— 連絡先を削除
• POST/api/v1/mail/contacts/import— 連絡先をインポート

配信リストの作成・管理およびメンバーの追加・削除を行います。

• 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/campaigns— キャンペーン一覧を取得
• POST/api/v1/mail/campaigns— キャンペーンを作成
• GET/api/v1/mail/campaigns/{id}— キャンペーンを取得
• PATCH/api/v1/mail/campaigns/{id}— キャンペーンを更新
• DELETE/api/v1/mail/campaigns/{id}— キャンペーンを削除
• POST/api/v1/mail/campaigns/{id}/send— キャンペーンを送信
• GET/api/v1/mail/campaigns/{id}/stats— キャンペーン統計を取得

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

• 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— シナリオを一時停止

シナリオ内の個別ステップ（メール送信・待機等）の追加・更新・削除を行います。

• POST/api/v1/mail/scenarios/{id}/steps— ステップを追加
• PATCH/api/v1/mail/scenarios/{id}/steps/{stepId}— ステップを更新
• DELETE/api/v1/mail/scenarios/{id}/steps/{stepId}— ステップを削除

メール配信の分析データとダッシュボード情報を取得します。

• GET/api/v1/mail/analytics/overview— 分析概要を取得
• GET/api/v1/mail/dashboard— ダッシュボードを取得

メール配信の変更履歴を参照します。

• GET/api/v1/mail/audit-logs— 監査ログを取得