ナレッジベース

Zinn® Campaigns API および MCP: 開発者ガイド

サインイン、権限、サンプル、制限、エラー、Webhook、そして Zinn® Campaigns API のすべての操作と、AI アシスタントが MCP 経由で実行できる操作について説明します。

ダッシュボード上の Zinn® Campaigns で実行できるすべての操作は API 経由でも実行でき、その大部分は MCP 経由でお客様のアカウントに接続された AI アシスタントからも実行可能です。このガイドでは、サインイン、権限、両方の方法による実践例、制限事項、エラー、そして89種類の Campaigns 操作のすべてについて説明します。以下の操作一覧は弊社の API 仕様から生成されているため、常に API の実際の動作と一致しています。すべての操作の各フィールドは、[zinndigital.com/developers/api/zinn-campaigns] (https://zinndigital.com/developers/api/zinn-campaigns) の API リファレンスに記載されています。

サインイン

API キー。 ダッシュボードの設定 → API キーでキーを作成し、 Authorization: Bearer zdk_live_… として送信します (zdk_test_… キーはサンドボックスモードで動作します)。キーには必要な Campaigns の権限のみを付与し、それ以上の権限は付与しないでください。
AI アシスタント (MCP)。 アプリからサインインするか、接続トークン (zmcp_live_…) を使用して、 Claude、ChatGPT、Cursor、または任意の MCP クライアントを https://api.zinndigital.com/v1/mcp に接続します。 Claude、Cursor、または ChatGPT のアカウントへの接続 をご覧ください。同意画面で、 Zinn® Campaigns の権限にチェックを入れます。
権限。 email_marketing.view はキャンペーン、リスト、連絡先、フォーム、送信者、 SMS 設定、レポートを読み取ります。email_marketing.manage はそれらを作成および変更します。ご自身のメールサービスを通じて送信するキャンペーンでは、campaigns.view および campaigns.manage を使用します。
リセラー。 クライアント組織の1つを操作するには、org_id を渡します。キーまたは接続が対象とする組織が1つのみの場合は、省略してください。

例: API を使用してドラフトキャンペーンを作成する

curl -X POST https://api.zinndigital.com/v1/email-marketing/campaigns \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Spring sale",
  "subject": "Our spring sale starts today",
  "list_id": "<list id>",
  "sender_id": "<sender id>",
  "template": "basic"
}'

レスポンスは下書きを含む 201 です。 POST /v1/email-marketing/campaigns/{campaign_id}/test でテストし、 GET /v1/email-marketing/campaigns/{campaign_id}/lint でチェックして、 POST /v1/email-marketing/campaigns/{campaign_id}/send で送信してください。

例: AI アシスタントから同じ下書きを作成する

アシスタントにわかりやすい言葉で指示してください (例: 「件名『春のセールが本日スタート』で、春のセールという名前の Zinn® Campaigns のメールを下書きして」)。バックグラウンドで api_operations_search を使用して操作を検索し、api_operation_get でそのパラメータを読み取って、api_operation_call で実行します:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "api_operation_call",
    "arguments": {
      "operation_id": "createEmailMarketingCampaign",
      "confirm": true,
      "body": {
        "name": "Spring sale",
        "subject": "Our spring sale starts today"
      }
    }
  }
}

アシスタントが実行しないこと。 受信者への送信、料金や割り当ての消費を伴う操作 (キャンペーンの送信、SMS や WhatsApp メッセージの送信、AI クレジットを使用した作成、US テキストメッセージの登録など) はアシスタントには拒否されるため、誤って解釈された指示がお客様に届くことは決してありません。アシスタントは下書きを作成します。お客様自身がダッシュボードで送信を押すか、直接 API を呼び出してください。また、SMTP パスワードなどの機密情報がアシスタントを経由することもありません。これらはダッシュボードに入力してください。

制限

各ユーザーまたは API キーにつき毎分1,200件のリクエスト、各組織につき毎分6,000件のリクエスト。2つのうち、より厳しい制限が適用されます。
各 MCP 接続につき毎分600件のリクエスト。
制限を超えた場合、返答はRetry-Afterヘッダー付きの429となります。その秒数だけ待機してください。
リストメンバーの追加は1回のリクエストにつき最大1,000件のアドレスとなります。お客様のプランの連絡先およびメールの割り当ては、API を通じて行うすべての操作に適用されます。

エラー

すべてのエラーは同じ形式となります:

{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}

同じ問題に対して code が変わることはないため、message ではなくこちらを判定してください。サポートにお問い合わせの際は request_id をお伝えください。返される応答は次のとおりです: 401 UNAUTHORIZED、403 FORBIDDEN、404 NOT_FOUND、409 CONFLICT、422 UNPROCESSABLE_ENTITY、429 TOO_MANY_REQUESTS。403 は、キーまたは接続に以下のリストに記載された権限がないことを意味します。404 は、お客様が表示権限を持たない組織内の項目も対象となります。422 は details 内に問題のある各フィールドを一覧表示します。429 の後は、Retry-After ヘッダーに示された秒数だけ待機してください。

Webhook

配信結果は、メールを送信するプロバイダーから Zinn® Campaigns へ届きます:

独自のプロバイダー (例: Resend) をご利用の場合は、ダッシュボードの送信接続 (キャンペーン → 送信) に Webhook 署名シークレットを保存します。webhook_url が取得されますので、プロバイダーの配信済み、バウンス、および苦情イベントをその URL に向けてください。バウンスやスパム苦情が発生すると、そのアドレスは今後の送信対象から直ちに除外されます。
Zinn® の送信機能をご利用の場合、設定する項目はありません。

レポート操作 (getEmailMarketingCampaignReport、getSmsMarketingCampaignReport) を使用して結果を確認してください。

すべての Campaigns 操作

概要

GET /v1/email-marketing — 1 つの組織の Zinn® Campaigns 概要。操作 getEmailMarketingOverview。確認される権限: email_marketing.view。AI アシスタントから: 可能 (MCP 経由)。

メールキャンペーン

GET /v1/email-marketing/campaigns — メールキャンペーン (新しい順、キーセット1ページ)。操作: listEmailMarketingCampaigns。確認される権限: email_marketing.view。AI アシスタントから: 可能 (MCP 経由)。
POST /v1/email-marketing/campaigns — 下書きのメールキャンペーンを作成します。操作: createEmailMarketingCampaign。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: 可能 (MCP 経由)。
GET /v1/email-marketing/campaigns/{campaign_id} — 単一のメールキャンペーン。操作: getEmailMarketingCampaign。確認される権限: email_marketing.view。AI アシスタントから: 可能 (MCP 経由)。
PATCH /v1/email-marketing/campaigns/{campaign_id} — 下書き (または下書きに戻された却下済みキャンペーン) を編集します。操作: updateEmailMarketingCampaign。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: 可能 (MCP 経由)。
GET /v1/email-marketing/campaigns/{campaign_id}/lint — 送信前にキャンペーンの文面をチェックし、到達性の問題がないか確認します。操作: lintEmailMarketingCampaign。確認される権限: email_marketing.view。AI アシスタントから: 可能 (MCP 経由)。
GET /v1/email-marketing/campaigns/{campaign_id}/report — キャンペーンの数値データ。操作: getEmailMarketingCampaignReport。確認される権限: email_marketing.view。AI アシスタントから: 可能 (MCP 経由)。
POST /v1/email-marketing/campaigns/{campaign_id}/send — キャンペーンのリストへの送信を開始します。操作 sendEmailMarketingCampaign。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: API およびダッシュボードのみ: 費用または利用枠を消費するため、担当者が押下します (実際の宛先に送信され、利用枠が消費されます)。
POST /v1/email-marketing/campaigns/{campaign_id}/test — 組織のメンバーに今すぐテストメールを1通送信します。操作 testEmailMarketingCampaign。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい、MCP 経由。
POST /v1/email-marketing/campaigns/{campaign_id}/translate — キャンペーンを、未作成または古い連絡先言語のすべてに翻訳します。操作 translateEmailMarketingCampaign。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい、MCP 経由。
GET /v1/email-marketing/campaigns/{campaign_id}/translations — キャンペーンリストの各連絡先言語と、その翻訳が最新であるかどうか。操作 listEmailMarketingCampaignTranslations。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由。

AI での執筆

POST /v1/email-marketing/ai/write — Zinn® AI を使用して、短い概要からキャンペーンメールの下書きを作成します。操作 writeEmailMarketingCampaignWithAi。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: API およびダッシュボードのみ: 費用または利用枠を消費するため、担当者がボタンを押します (AI による執筆は AI クレジットを消費します)。

ブランドキット

GET /v1/email-marketing/brand-kit — 組織のブランドキット (名前、ロゴ、色、フォント、トーン)。操作 getEmailMarketingBrandKit。確認される権限: email_marketing.view。AI アシスタントから: はい (MCP 経由)。
PUT /v1/email-marketing/brand-kit — ブランドキットを編集します。操作 updateEmailMarketingBrandKit。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい (MCP 経由)。
POST /v1/email-marketing/brand-kit/read — 組織のウェブサイトからブランドキットを読み取ります。操作 readEmailMarketingBrandKit。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい (MCP 経由)。

連絡先および個別メッセージ

GET /v1/email-marketing/contacts — 組織の連絡先 (一度にキーセット1ページ分)。オペレーション listEmailMarketingContacts。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由。
POST /v1/email-marketing/contacts/{contact_id}/messages — 1件の連絡先に SMS を1通送信 (Zinn®のクレジット残高から支払い)。オペレーション sendEmailMarketingMessage。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: API およびダッシュボードのみ (費用または利用枠を消費するため、人間が実行します。連絡先への単発メッセージは利用枠を消費します)。
GET /v1/email-marketing/messages — 組織が送信した SMS および WhatsApp メッセージ (新しい順、キーセット1ページ分)。オペレーション listEmailMarketingMessages。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由。

GET /v1/email-marketing/lists — 組織のメーリングリストおよび登録済み／登録解除済みの件数。操作 listEmailMarketingLists。確認される権限: email_marketing.view。AI アシスタントから: 可能、MCP 経由。
POST /v1/email-marketing/lists — メーリングリストを作成 (またはその名前の既存リストを返却)。操作 createEmailMarketingList。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: 可能、MCP 経由。
POST /v1/email-marketing/lists/{list_id}/members — メールアドレスでリストに連絡先を追加 (1リクエストあたり最大1,000件)。操作 addEmailMarketingListMembers。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: 可能、MCP 経由。

インポート

GET /v1/email-marketing/imports — 過去の連絡先インポート履歴 (新しい順、一度に1キーセットページ)。操作 listEmailMarketingImports。確認される権限: email_marketing.view。AI アシスタントから: 可能、MCP 経由。
POST /v1/email-marketing/imports — 同意証明とともに連絡先の1チャンクをインポート。操作 createEmailMarketingImport。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: 可能、MCP 経由。

登録フォーム

GET /v1/email-marketing/forms — 登録フォーム (ダブルオプトイン)、新しい順、キーセット1ページ。操作 listEmailMarketingForms。確認される権限: email_marketing.view。AI アシスタントから: 可能、MCP 経由。
POST /v1/email-marketing/forms — 確認済みのユーザーを1つのリストに追加する登録フォームを作成します。操作 createEmailMarketingForm。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: 可能、MCP 経由。
DELETE /v1/email-marketing/forms/{form_id} — 登録フォームを削除します (すでに確認済みのユーザーはリストに残ります)。操作 deleteEmailMarketingForm。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: 可能、MCP 経由。
PATCH /v1/email-marketing/forms/{form_id} — 登録フォームを変更します (文言、リスト、リダイレクト、有効/無効)。操作 updateEmailMarketingForm。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: 可能、MCP 経由。

送信接続

GET /v1/email-marketing/senders — 組織の送信接続。操作 listEmailMarketingSenders。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由。
POST /v1/email-marketing/senders — キャンペーン送信者を接続します (Zinn® 送信、またはお客様独自の SMTP サーバー)。操作 createEmailMarketingSender。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: API およびダッシュボードのみ: AI モデルに絶対に届いてはならないシークレットが含まれます (本文は SMTP パスワードです)。
DELETE /v1/email-marketing/senders/{sender_id} — 送信接続と保存されたパスワードを削除します。操作 deleteEmailMarketingSender。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい、MCP 経由。
POST /v1/email-marketing/senders/{sender_id}/verify — 何も送信せずに、送信接続が機能することを確認します。操作 verifyEmailMarketingSender。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい、MCP 経由。
PUT /v1/email-marketing/senders/{sender_id}/webhook — この接続に対するメールプロバイダーの Webhook 署名シークレットを保存します。操作 setEmailMarketingSenderWebhook。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: お客様ではなく、別のシステム (プロバイダーまたは訪問者) によって呼び出されます (プロバイダーの Webhook シークレットを保存します)。

SMS および WhatsApp

GET /v1/email-marketing/sms — SMS 画面に必要な情報 — 開始中か、一時停止中か、クレジット残高、料金。操作 getEmailMarketingSms。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由。
GET /v1/email-marketing/sms/campaigns — 一斉送信 SMS キャンペーン (最新順、keyset ページネーション1ページ分)。操作 listSmsMarketingCampaigns。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由。
POST /v1/email-marketing/sms/campaigns — リスト向け SMS 下書きの作成。操作 createSmsMarketingCampaign。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい、MCP 経由。
GET /v1/email-marketing/sms/campaigns/{campaign_id} — 個別の一斉送信 SMS キャンペーン。操作 getSmsMarketingCampaign。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由。
PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — 下書き (または下書きに戻る拒絶されたキャンペーン) の編集。操作 updateSmsMarketingCampaign。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい、MCP 経由。
GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — 一斉送信 SMS キャンペーンの数値。操作 getSmsMarketingCampaignReport。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由。
POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — SMS の受信に同意したリスト内の全員への SMS 送信を開始するか、クレジット不足で一時停止した送信を再開します。操作 sendSmsMarketingCampaign。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: API およびダッシュボードのみ: 費用または許容量を消費するため、担当者が実行してください (有料の SMS/WhatsApp メッセージを送信します)。
GET /v1/email-marketing/sms/registrations/us — この組織の US 10DLC 登録情報およびその費用を取得します。操作 getEmailMarketingUsRegistration。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由で可能です。
POST /v1/email-marketing/sms/registrations/us — US 10DLC 向けにこの組織のブランドおよびキャンペーンを申請します (申請時に課金)。操作 submitEmailMarketingUsRegistration。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: API およびダッシュボードのみ: 費用または許容量を消費するため、担当者が実行してください (US 10DLC 登録には通信事業者の手数料が発生します)。

独自のメールサービスによるキャンペーン (テンプレート、セグメント、配信除外)

GET /v1/campaigns — 組織のキャンペーン一覧を取得します。操作 listCampaigns。AI アシスタントから: はい、MCP 経由で可能です。
POST /v1/campaigns — テンプレートとオーディエンスからキャンペーンを作成します。操作 createCampaign。AI アシスタントから: はい、MCP 経由で可能です。
DELETE /v1/campaigns/esp — プロバイダーアカウントの接続を解除し、保存されているキーを削除します。操作 disconnectEsp。AI アシスタントから: API およびダッシュボードのみ: AI モデルに絶対に渡してはならないシークレットが含まれます (保存された ESP キーを破棄します)。
GET /v1/campaigns/esp — 組織独自のメールプロバイダーアカウント。操作 getEspConnection。AI アシスタントから: はい、MCP 経由。
POST /v1/campaigns/esp — メールプロバイダーアカウントを接続します。操作 connectEsp。AI アシスタントから: API およびダッシュボードのみ: AI モデルに絶対に渡してはならないシークレットが含まれます (本文が ESP API キーです)。
POST /v1/campaigns/esp/verify — プロバイダーアカウントが機能することを証明し、検証済みドメインを読み取ります。操作 verifyEspConnection。AI アシスタントから: API およびダッシュボードのみ: AI モデルに絶対に渡してはならないシークレットが含まれます (保存された ESP キーを再確認します)。
POST /v1/campaigns/preview — サンプル値を使用してテンプレートを Render します。操作 previewCampaignTemplate。AI アシスタントから: はい、MCP 経由。
GET /v1/campaigns/segments — 保存されたオーディエンスセグメント。操作 listCampaignSegments。確認された権限: campaigns.view。AI アシスタントから: はい、MCP 経由。
POST /v1/campaigns/segments — 新しいオーディエンスセグメントを保存します。操作 createCampaignSegment。確認された権限: campaigns.manage。AI アシスタントから: はい、MCP 経由。
GET /v1/campaigns/segments/fields — フィルターの語彙、その値リスト、マジックタグ。操作 getCampaignSegmentFields。確認される権限: campaigns.view。AI アシスタントから: はい (MCP 経由)。
POST /v1/campaigns/segments/preview — リーチする人数、対象者、除外対象者。操作 previewCampaignSegment。確認される権限: campaigns.view。AI アシスタントから: はい (MCP 経由)。
DELETE /v1/campaigns/segments/{segmentId} — セグメントをアーカイブします。操作 archiveCampaignSegment。確認される権限: campaigns.manage。AI アシスタントから: はい (MCP 経由)。
GET /v1/campaigns/segments/{segmentId} — 保存された1つのセグメント。操作 getCampaignSegment。確認される権限: campaigns.view。AI アシスタントから: はい (MCP 経由)。
PATCH /v1/campaigns/segments/{segmentId} — セグメントの名前を変更するか、フィルターを変更します。操作 updateCampaignSegment。確認される権限: campaigns.manage。AI アシスタントから: はい (MCP 経由)。
GET /v1/campaigns/suppressions — マーケティングを受信してはならないアドレス。操作 listCampaignSuppressions。確認される権限: campaigns.view。AI アシスタントから: はい (MCP 経由)。
POST /v1/campaigns/suppressions — 配信停止リストにアドレスを追加します。操作 createCampaignSuppression。確認される権限: campaigns.manage。AI アシスタントから: はい (MCP 経由)。
GET /v1/campaigns/tags — キャンペーン作成機能が提供するマジックタグパレットです。操作 listCampaignTags。AI アシスタントから: はい、MCP 経由。
GET /v1/campaigns/templates — 組織のキャンペーンテンプレートです。操作 listCampaignTemplates。AI アシスタントから: はい、MCP 経由。
POST /v1/campaigns/templates — キャンペーンテンプレートを作成します。操作 createCampaignTemplate。AI アシスタントから: はい、MCP 経由。
DELETE /v1/campaigns/templates/{templateId} — テンプレートをアーカイブし、その翻訳ソースを廃止します。操作 archiveCampaignTemplate。AI アシスタントから: はい、MCP 経由。
GET /v1/campaigns/templates/{templateId} — 単一のキャンペーンテンプレートです。操作 getCampaignTemplate。AI アシスタントから: はい、MCP 経由。
PUT /v1/campaigns/templates/{templateId} — キャンペーンテンプレートを編集します。操作 updateCampaignTemplate。AI アシスタントから: はい、MCP 経由。
POST /v1/campaigns/unsubscribe — マーケティングリストから退会します。アカウントは不要です。操作 unsubscribeFromCampaigns。AI アシスタントから: API およびダッシュボードのみ: AI モデルに絶対に渡してはならないシークレットを含みます (受信者の署名済み配信停止トークンを受け取ります)。
DELETE /v1/campaigns/{campaignId} — キャンペーンを削除し、その配信行を廃止します。操作 deleteCampaign。AI アシスタントから: API およびダッシュボードのみ: AI 接続には付与されない権限が必要です (ESP キャンペーンの削除には campaigns.send が必要です)。
GET /v1/campaigns/{campaignId} — 1件のキャンペーンとその配信レポート。操作 getCampaign。AI アシスタントから: 可、MCP 経由。
POST /v1/campaigns/{campaignId}/control — 実行中の送信を一時停止、再開、またはキャンセルします。操作 controlCampaign。AI アシスタントから: API およびダッシュボードのみ: 費用またはクォータを消費するため、担当者が操作します (本番送信の一時停止/再開)。
POST /v1/campaigns/{campaignId}/send — 永続的な送信を開始します。操作 sendCampaign。AI アシスタントから: API およびダッシュボードのみ: 費用またはクォータを消費するため、担当者が操作します (実際の受信者に ESP キャンペーンを送信)。
POST /v1/campaigns/{campaignId}/test — キャンペーンが実際に使用するチャネルで本番メッセージを1件送信します。操作 testSendCampaign。AI アシスタントから: API およびダッシュボードのみ: AI 接続には付与されない権限が必要です (ESP テスト送信には campaigns.send が必要です)。

公開ページと受信 Webhook

GET /v1/public/email-marketing/c/{token} — クリックカウンター。受信者ごとに1クリックを記録し、元のリンクへリダイレクトします。操作 emailMarketingClick。AI アシスタントから: 受信者がメールから開くページ (クリック追跡リダイレクト)。
GET /v1/public/email-marketing/f/{public_id} — 登録フォームのホスト済みページ (ログイン不要)。操作 emailMarketingFormPage。AI アシスタントから: 受信者がメールから開くページ (公開登録フォームページ)。
POST /v1/public/email-marketing/f/{public_id} — 登録フォームを送信します (ホストされたページ、埋め込み、または JSON)。オペレーション emailMarketingFormSubmit。AI アシスタントより: お客様ではなく、別のシステム (プロバイダーまたは訪問者) によって呼び出されます (訪問者が登録フォームを送信します)。
GET /v1/public/email-marketing/fc — ダブルオプトイン確認ページ (ログイン不要)。オペレーション emailMarketingFormConfirmPage。AI アシスタントより: 受信者がメールから開くページです (ダブルオプトイン確認ページ)。
POST /v1/public/email-marketing/fc — 登録を確認します (同意記録とともに対象者をリストに追加します)。オペレーション emailMarketingFormConfirm。AI アシスタントより: お客様ではなく、別のシステム (プロバイダーまたは訪問者) によって呼び出されます (訪問者がダブルオプトインを確認します)。
GET /v1/public/email-marketing/o/{token} — 開封追跡画像 (1x1の GIF)。受信者1人につき1回の開封をカウントします。オペレーション emailMarketingOpenPixel。AI アシスタントより: 受信者がメールから開くページです (開封追跡ピクセル)。
GET /v1/public/email-marketing/u/{token} — フッターの配信停止リンク (ログイン不要)。オペレーション emailMarketingUnsubscribePage。AI アシスタントより: 受信者がメールから開くページです (配信停止ページ)。
POST /v1/public/email-marketing/u/{token} — RFC 8058 ワンクリック配信停止 (およびページの「すべて停止」ボタン)。オペレーション emailMarketingUnsubscribeOneClick。AI アシスタントより: お客様ではなく、別のシステム (プロバイダーまたは訪問者) によって呼び出されます (RFC 8058 ワンクリック配信停止)。
GET /v1/public/email-marketing/warmup-u/{token} — マーケティングプールのウォームアップメールの配信停止リンク (ログイン不要)。オペレーション emailMarketingWarmupUnsubscribePage。AI アシスタントより: 受信者がメールから開くページです (ウォームアップ配信停止ページ)。
POST /v1/public/email-marketing/warmup-u/{token} — ウォームアップメールからの RFC 8058 ワンクリック配信停止。オペレーション emailMarketingWarmupUnsubscribeOneClick。AI アシスタントより: お客様ではなく、別のシステム (プロバイダーまたは訪問者) によって呼び出されます (ウォームアップワンクリック配信停止)。
POST /v1/webhooks/campaign-events — メールプロバイダーからの署名済み配信イベントを取り込みます。オペレーション receiveCampaignDeliveryWebhook。AI アシスタントより: お客様ではなく、別のシステム (プロバイダーまたは訪問者) によって呼び出されます (署名済み ESP 配信 Webhook)。
POST /v1/webhooks/campaigns/telnyx — SMS ベンダーからの受信 SMS 返信 (STOP / START)。オペレーション receiveCampaignsTelnyxInbound。AI アシスタントより: お客様ではなく、別のシステム (プロバイダーまたは訪問者) によって呼び出されます (署名済み Telnyx 受信 Webhook)。
POST /v1/webhooks/email-marketing/{connection_id} — 1つの送信接続に対する、顧客独自のメールプロバイダーからの配信イベントです。操作 receiveEmailMarketingProviderWebhook。AI アシスタントから: お客様ではなく、別のシステム (プロバイダーまたは訪問者) によって呼び出されます (署名付き送信者プロバイダー Webhook)。

フロー

GET /v1/email-marketing/flows — メールフロー (ウェルカム、ステップ配信、年次日程)、キームセット1ページ分です。操作 listEmailMarketingFlows。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由です。
POST /v1/email-marketing/flows — フローを作成します (下書きとして開始されます)。操作 createEmailMarketingFlow。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい、MCP 経由です。
DELETE /v1/email-marketing/flows/{flow_id} — フローとその登録を削除します (送信済みの実行はキャンペーンとして残ります)。操作 deleteEmailMarketingFlow。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントから: はい、MCP 経由です。
GET /v1/email-marketing/flows/{flow_id} — ステップおよびレポート (ステップごとの登録数、進行中、実行数、受信者数) を含む1つのフローです。操作 getEmailMarketingFlow。確認される権限: email_marketing.view。AI アシスタントから: はい、MCP 経由です。
PATCH /v1/email-marketing/flows/{flow_id} — フローを変更します。steps が指定されている場合、シーケンス全体が置き換えられます。操作 updateEmailMarketingFlow。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントからの実行: 可能 (MCP 経由)。
POST /v1/email-marketing/flows/{flow_id}/activate — フローを有効化します。今後リストに参加する人のみが登録されます。操作 activateEmailMarketingFlow。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントからの実行: 可能 (MCP 経由)。
POST /v1/email-marketing/flows/{flow_id}/pause — フローを一時停止します。予定されているステップは保留され、再び有効化されるまで新しい受信者にメールが送信されることはありません。操作 pauseEmailMarketingFlow。確認される権限: email_marketing.manage、email_marketing.view。AI アシスタントからの実行: 可能 (MCP 経由)。