Zinn® Campaigns API und MCP: Entwicklerhandbuch

Alles, was Sie in Zinn® Campaigns über das Dashboard tun können, können Sie auch über die API ausführen, und das meiste davon sogar über einen KI-Assistenten, der über MCP mit Ihrem Konto verbunden ist. Dieser Leitfaden behandelt die Anmeldung, die Berechtigungen, ein praktisches Beispiel für beide Wege, die Limits, die Fehler und jede einzelne der 89 Campaigns-Operationen. Die nachstehende Operationsliste wird aus unserer API-Spezifikation generiert, sodass sie stets genau dem entspricht, was die API ausführt. Jedes Feld jeder Operation ist in der API-Referenz unter zinndigital.com/developers/api/zinn-campaigns aufgeführt.

Anmelden

• API-Schlüssel. Erstellen Sie einen Schlüssel im Dashboard unter Einstellungen → API-Schlüssel und senden Sie ihn als Authorization: Bearer zdk_live_… (ein zdk_test_…-Schlüssel funktioniert im Sandbox-Modus). Weisen Sie dem Schlüssel nur die Kampagnen-Berechtigungen zu, die er benötigt, und keine weiteren.
• KI-Assistenten (MCP). Verbinden Sie Claude, ChatGPT, Cursor oder einen beliebigen MCP-Client mit https://api.zinndigital.com/v1/mcp, entweder durch Anmeldung über die App oder mit einem Verbindungs-Token (zmcp_live_…). Siehe Verbinden von Claude, Cursor oder ChatGPT mit Ihrem Konto. Setzen Sie auf dem Zustimmungsbildschirm ein Häkchen bei den Berechtigungen für Zinn® Campaigns.
• Berechtigungen. email_marketing.view liest Kampagnen, Listen, Kontakte, Formulare, Absender, SMS-Einstellungen und Berichte; email_marketing.manage erstellt und ändert diese. Die Kampagnen, die Sie über Ihren eigenen E-Mail-Dienst versenden, verwenden campaigns.view und campaigns.manage.
• Reseller. Übergeben Sie org_id, um im Namen einer Ihrer Kundenorganisationen zu handeln. Lassen Sie diesen Parameter weg, wenn Ihr Schlüssel oder Ihre Verbindung genau eine Organisation erreicht.

Beispiel: Erstellen eines Kampagnenentwurfs über die 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"
}'

Die Antwort lautet 201 mit dem Entwurf. Testen Sie ihn mit POST /v1/email-marketing/campaigns/{campaign_id}/test, prüfen Sie ihn mit GET /v1/email-marketing/campaigns/{campaign_id}/lint und senden Sie ihn mit POST /v1/email-marketing/campaigns/{campaign_id}/send.

Beispiel: derselbe Entwurf von einem KI-Assistenten

Bitten Sie Ihren Assistenten in einfachen Worten, zum Beispiel: „Erstelle einen Zinn® Campaigns-Entwurf für eine E-Mail namens Frühlings-Sale mit dem Betreff ‚Unser Frühlings-Sale beginnt heute‘“. Im Hintergrund sucht er die Operation mit api_operations_search, liest ihre Parameter mit api_operation_get und führt sie mit api_operation_call aus:

{
  "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"
      }
    }
  }
}

Was ein Assistent nicht tut. Alles, was Sendungen an Ihre Empfänger veranlasst oder Geld beziehungsweise Kontingente verbraucht – das Versenden einer Kampagne, das Senden von SMS- oder WhatsApp-Nachrichten, das Schreiben mit KI-Guthaben, die Registrierung für den US-Nachrichtenversand –, wird einem Assistenten verweigert, sodass eine missverstandene Anweisung niemals Ihre Kunden erreichen kann. Der Assistent bereitet den Entwurf vor; Sie klicken im Dashboard auf Senden oder rufen die API selbst auf. Geheimnisse wie ein SMTP-Passwort werden ebenfalls niemals über einen Assistenten weitergegeben: Geben Sie diese im Dashboard ein.

Limits

• 1.200 Anfragen pro Minute für jede Person oder jeden API-Schlüssel und 6.000 Anfragen pro Minute für jede Organisation. Es gilt jeweils das strengere Limit.
• 600 Anfragen pro Minute für jede MCP-Verbindung.
• Bei einer Überschreitung des Limits lautet die Antwort 429 mit einem Retry-After-Header: Warten Sie die angegebene Anzahl an Sekunden.
• Das Hinzufügen von Listenmitgliedern umfasst maximal 1.000 Adressen pro Anfrage; die Kontakt- und E-Mail-Kontingente Ihres Tarifs gelten für alle Aktionen, die Sie über die API durchführen.

Fehler

Jeder Fehler hat dieselbe Struktur:

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

code ändert sich bei demselben Problem nie, testen Sie also lieber diesen Wert als message. Geben Sie request_id an, wenn Sie den Support kontaktieren. Die Antworten, auf die Sie stoßen werden: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. Ein 403 bedeutet, dass dem Schlüssel oder der Verbindung eine in der folgenden Liste genannte Berechtigung fehlt; ein 404 deckt auch ein Objekt in einer Organisation ab, das Sie nicht sehen können; ein 422 listet jedes fehlerhafte Feld in details auf; warten Sie nach einem 429 die im Header Retry-After angegebene Anzahl von Sekunden.

Webhooks

Zustellungs-Ergebnisse gelangen in Zinn® Campaigns von dem Anbieter, der Ihre E-Mail versendet:

• Bei Ihrem eigenen Anbieter (zum Beispiel Resend) hinterlegen Sie dessen Webhook-Signiergeheimnis in der Sendeverbindung im Dashboard (Kampagnen → Versand). Sie erhalten eine webhook_url; leiten Sie die Ereignisse „Zugestellt“, „Unzustellbar“ und „Beschwerde“ des Anbieters dorthin weiter. Eine Unzustellbarkeit oder eine Spam-Beschwerde entfernt die Adresse sofort aus künftigen Sendungen.
• Beim Zinn®-Versand muss nichts eingerichtet werden.

Lesen Sie die Ergebnisse mit den Berichtsoperationen (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport) aus.

Jede Campaigns-Operation

Übersicht

• GET /v1/email-marketing — Zinn® Campaigns-Übersicht für eine Organisation. Operation getEmailMarketingOverview. Geprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: Ja, über das MCP.

E-Mail-Kampagnen

• GET /v1/email-marketing/campaigns — E-Mail-Kampagnen, neueste zuerst, eine Keyset-Seite. Operation listEmailMarketingCampaigns. Geprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/campaigns — Entwurf einer E-Mail-Kampagne erstellen. Operation createEmailMarketingCampaign. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• GET /v1/email-marketing/campaigns/{campaign_id} — Eine E-Mail-Kampagne. Operation getEmailMarketingCampaign. Geprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — Einen Entwurf bearbeiten (oder eine abgelehnte Kampagne, die wieder zum Entwurf wird). Operation updateEmailMarketingCampaign. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — Den Text einer Kampagne vor dem Versand auf Zustellbarkeitsprobleme prüfen. Operation lintEmailMarketingCampaign. Geprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — Zahlen einer Kampagne. Operation getEmailMarketingCampaignReport. Geprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — Den Versand einer Kampagne an ihre Liste starten. Operation sendEmailMarketingCampaign. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: Nur API und Dashboard: Es fallen Kosten an oder das Kontingent wird beansprucht, daher muss eine Person darauf klicken (sendet an reale Empfänger und verbraucht Kontingent).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — Jetzt eine Testkopie an ein Mitglied der Organisation senden. Operation testEmailMarketingCampaign. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: Ja, über das MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — Eine Kampagne in jede Kontaktsprache übersetzen, die fehlt oder veraltet ist. Operation translateEmailMarketingCampaign. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: Ja, über das MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — Jede Kontaktsprache der Liste einer Kampagne und die Angabe, ob die Übersetzung aktuell ist. Operation listEmailMarketingCampaignTranslations. Geprüfte Berechtigungen: email_marketing.view. Über einen KI-Assistenten: Ja, über das MCP.

Schreiben mit KI

• POST /v1/email-marketing/ai/write — Schreiben Sie anhand eines kurzen Briefings mit Zinn® AI einen Entwurf für eine Kampagnen-E-Mail. Operation writeEmailMarketingCampaignWithAi. Überprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: Nur API und Dashboard: Es verbraucht Geld oder Kontingente, daher betätigt dies eine Person (KI-Schreiben verbraucht KI-Guthaben).

Brand-Kit

• GET /v1/email-marketing/brand-kit — Das Brand-Kit der Organisation (Name, Logo, Farben, Schriftart, Tonalität). Operation getEmailMarketingBrandKit. Überprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: Ja, über das MCP.
• PUT /v1/email-marketing/brand-kit — Bearbeiten Sie das Brand-Kit. Operation updateEmailMarketingBrandKit. Überprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: Ja, über das MCP.
• POST /v1/email-marketing/brand-kit/read — Lesen Sie das Brand-Kit von der Website der Organisation aus. Operation readEmailMarketingBrandKit. Überprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: Ja, über das MCP.

Kontakte und einmalige Nachrichten

• GET /v1/email-marketing/contacts — Die Kontakte der Organisation, jeweils eine Keyset-Seite. Operation listEmailMarketingContacts. Geprüfte Berechtigungen: email_marketing.view. Über einen KI-Assistenten: Ja, über das MCP.
• POST /v1/email-marketing/contacts/{contact_id}/messages — Senden Sie eine SMS an einen Kontakt, bezahlt aus dem Zinn®-Guthaben. Operation sendEmailMarketingMessage. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: Nur API und Dashboard: Es fallen Kosten oder Kontingente an, daher muss eine Person darauf klicken (eine einmalige Nachricht an einen Kontakt verbraucht Kontingent).
• GET /v1/email-marketing/messages — Von der Organisation gesendete SMS- und WhatsApp-Nachrichten, die neuesten zuerst, eine Keyset-Seite. Operation listEmailMarketingMessages. Geprüfte Berechtigungen: email_marketing.view. Über einen KI-Assistenten: Ja, über das MCP.

Listen

• GET /v1/email-marketing/lists — Die Mailinglisten der Organisation mit der Anzahl der Abonnenten / abgemeldeten Kontakte. Operation listEmailMarketingLists. Geprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/lists — Eine Mailingliste erstellen (oder die Liste mit diesem Namen zurückgeben). Operation createEmailMarketingList. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/lists/{list_id}/members — Kontakte anhand der E-Mail-Adresse zu einer Liste hinzufügen (maximal 1.000 pro Anfrage). Operation addEmailMarketingListMembers. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.

Importe

• GET /v1/email-marketing/imports — Vergangene Kontaktimporte, die neuesten zuerst, jeweils eine Keyset-Seite. Operation listEmailMarketingImports. Geprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/imports — Einen Block von Kontakten mit der zugehörigen Einwilligungserklärung importieren. Operation createEmailMarketingImport. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.

Anmeldeformulare

• GET /v1/email-marketing/forms — Anmeldeformulare (Double-Opt-in), die neuesten zuerst, eine Keyset-Seite. Operation listEmailMarketingForms. Geprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: Ja, über das MCP.
• POST /v1/email-marketing/forms — Erstellen Sie ein Anmeldeformular, das bestätigte Personen zu einer Liste hinzufügt. Operation createEmailMarketingForm. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: Ja, über das MCP.
• DELETE /v1/email-marketing/forms/{form_id} — Löschen Sie ein Anmeldeformular (bereits bestätigte Personen verbleiben auf der Liste). Operation deleteEmailMarketingForm. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: Ja, über das MCP.
• PATCH /v1/email-marketing/forms/{form_id} — Ändern Sie ein Anmeldeformular (Formulierung, Liste, Weiterleitung, aktiviert oder deaktiviert). Operation updateEmailMarketingForm. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: Ja, über das MCP.

Sendeverbindungen

• GET /v1/email-marketing/senders — Die Sendeverbindungen der Organisation. Operation listEmailMarketingSenders. Geprüfte Berechtigungen: email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/senders — Einen Kampagnenabsender verbinden (Zinn®-Versand oder der eigene SMTP-Server des Kunden). Operation createEmailMarketingSender. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: nur API und Dashboard: enthält ein Geheimnis, das niemals ein KI-Modell erreichen darf (der Textkörper ist das SMTP-Passwort).
• DELETE /v1/email-marketing/senders/{sender_id} — Eine Sendeverbindung und ihr gespeichertes Passwort entfernen. Operation deleteEmailMarketingSender. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/senders/{sender_id}/verify — Nachweisen, dass eine Sendeverbindung funktioniert, ohne etwas zu senden. Operation verifyEmailMarketingSender. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: ja, über das MCP.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — Das Webhook-Signiergeheimnis Ihres E-Mail-Anbieters für diese Verbindung speichern. Operation setEmailMarketingSenderWebhook. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Von einem KI-Assistenten: von einem anderen System aufgerufen (einem Anbieter oder einem Besucher), nicht von Ihnen (speichert das Webhook-Geheimnis eines Anbieters).

SMS und WhatsApp

• GET /v1/email-marketing/sms — Was der SMS-Bildschirm benötigt — geöffnet?, pausiert?, Guthabenstand und Preise. Operation getEmailMarketingSms. Geprüfte Berechtigungen: email_marketing.view. Über einen KI-Assistenten: ja, über das MCP.
• GET /v1/email-marketing/sms/campaigns — Massen-SMS-Kampagnen, neueste zuerst, eine Keyset-Seite. Operation listSmsMarketingCampaigns. Geprüfte Berechtigungen: email_marketing.view. Über einen KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/sms/campaigns — Entwurf einer SMS an eine Liste erstellen. Operation createSmsMarketingCampaign. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: ja, über das MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — Eine Massen-SMS-Kampagne. Operation getSmsMarketingCampaign. Geprüfte Berechtigungen: email_marketing.view. Über einen KI-Assistenten: ja, über das MCP.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Entwurf bearbeiten (oder eine abgelehnte Kampagne, die wieder zum Entwurf wird). Operation updateSmsMarketingCampaign. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: ja, über das MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Kennzahlen einer Massen-SMS-Kampagne. Operation getSmsMarketingCampaignReport. Geprüfte Berechtigungen: email_marketing.view. Über einen KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Den Versand einer SMS an alle Empfänger auf der Liste starten, die dem SMS-Empfang zugestimmt haben — oder eine wegen unzureichendem Guthaben pausierte Kampagne fortsetzen. Operation sendSmsMarketingCampaign. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: Nur API und Dashboard: Es verbraucht Guthaben oder Kontingente, daher muss eine Person die Aktion ausführen (versendet kostenpflichtige SMS-/WhatsApp-Nachrichten).
• GET /v1/email-marketing/sms/registrations/us — Die US 10DLC-Registrierung dieser Organisation und deren Kosten. Operation getEmailMarketingUsRegistration. Geprüfte Berechtigungen: email_marketing.view. Über einen KI-Assistenten: Ja, über das MCP.
• POST /v1/email-marketing/sms/registrations/us — Marke und Kampagne dieser Organisation für US 10DLC einreichen (wird bei Einreichung berechnet). Operation submitEmailMarketingUsRegistration. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: Nur API und Dashboard: Es verbraucht Guthaben oder Kontingente, daher muss eine Person die Aktion ausführen (für die US 10DLC-Registrierung fallen Mobilfunkanbieter-Gebühren an).

Kampagnen über Ihren eigenen E-Mail-Dienst (Vorlagen, Segmente, Unterdrückungslisten)

• GET /v1/campaigns — Die Kampagnen der Organisation. Operation listCampaigns. Über einen KI-Assistenten: Ja, über das MCP.
• POST /v1/campaigns — Eine Kampagne anhand einer Vorlage und einer Zielgruppe erstellen. Operation createCampaign. Über einen KI-Assistenten: Ja, über das MCP.
• DELETE /v1/campaigns/esp — Trennen Sie das Anbieterkonto und entfernen Sie dessen gespeicherten Schlüssel. Operation disconnectEsp. Von einem KI-Assistenten: Nur API und Dashboard: Es enthält ein Geheimnis, das niemals ein KI-Modell erreichen darf (zerstört den gespeicherten ESP-Schlüssel).
• GET /v1/campaigns/esp — Das eigene E-Mail-Anbieterkonto der Organisation. Operation getEspConnection. Von einem KI-Assistenten: Ja, über das MCP.
• POST /v1/campaigns/esp — Verbinden Sie ein E-Mail-Anbieterkonto. Operation connectEsp. Von einem KI-Assistenten: Nur API und Dashboard: Es enthält ein Geheimnis, das niemals ein KI-Modell erreichen darf (der Textkörper ist der ESP-API-Schlüssel).
• POST /v1/campaigns/esp/verify — Weisen Sie nach, dass das Anbieterkonto funktioniert, und lesen Sie dessen verifizierte Domains aus. Operation verifyEspConnection. Von einem KI-Assistenten: Nur API und Dashboard: Es enthält ein Geheimnis, das niemals ein KI-Modell erreichen darf (überprüft einen gespeicherten ESP-Schlüssel erneut).
• POST /v1/campaigns/preview — Render eine Vorlage mit Beispielwerten. Operation previewCampaignTemplate. Von einem KI-Assistenten: Ja, über das MCP.
• GET /v1/campaigns/segments — Ihre gespeicherten Zielgruppensegmente. Operation listCampaignSegments. Geprüfte Berechtigungen: campaigns.view. Von einem KI-Assistenten: Ja, über das MCP.
• POST /v1/campaigns/segments — Speichern Sie ein neues Zielgruppensegment. Operation createCampaignSegment. Geprüfte Berechtigungen: campaigns.manage. Von einem KI-Assistenten: Ja, über das MCP.
• GET /v1/campaigns/segments/fields — Das Filtervokabular, seine Wertelisten und die magischen Tags. Operation getCampaignSegmentFields. Überprüfte Berechtigungen: campaigns.view. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/campaigns/segments/preview — Wie viele Personen dies erreicht, wer sie sind und wer ausgeschlossen wird. Operation previewCampaignSegment. Überprüfte Berechtigungen: campaigns.view. Von einem KI-Assistenten: ja, über das MCP.
• DELETE /v1/campaigns/segments/{segmentId} — Ein Segment archivieren. Operation archiveCampaignSegment. Überprüfte Berechtigungen: campaigns.manage. Von einem KI-Assistenten: ja, über das MCP.
• GET /v1/campaigns/segments/{segmentId} — Ein gespeichertes Segment. Operation getCampaignSegment. Überprüfte Berechtigungen: campaigns.view. Von einem KI-Assistenten: ja, über das MCP.
• PATCH /v1/campaigns/segments/{segmentId} — Ein Segment umbenennen oder seine Filter ändern. Operation updateCampaignSegment. Überprüfte Berechtigungen: campaigns.manage. Von einem KI-Assistenten: ja, über das MCP.
• GET /v1/campaigns/suppressions — Adressen, die kein Marketing erhalten dürfen. Operation listCampaignSuppressions. Überprüfte Berechtigungen: campaigns.view. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/campaigns/suppressions — Eine Adresse zur Ausschlussliste hinzufügen. Operation createCampaignSuppression. Überprüfte Berechtigungen: campaigns.manage. Von einem KI-Assistenten: ja, über das MCP.
• GET /v1/campaigns/tags — Die Magic-Tag-Palette, die ein Kampagnen-Editor bietet. Operation listCampaignTags. Von einem KI-Assistenten: ja, über das MCP.
• GET /v1/campaigns/templates — Die Kampagnenvorlagen der Organisation. Operation listCampaignTemplates. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/campaigns/templates — Eine Kampagnenvorlage erstellen. Operation createCampaignTemplate. Von einem KI-Assistenten: ja, über das MCP.
• DELETE /v1/campaigns/templates/{templateId} — Eine Vorlage archivieren und ihre Übersetzungsquellen stilllegen. Operation archiveCampaignTemplate. Von einem KI-Assistenten: ja, über das MCP.
• GET /v1/campaigns/templates/{templateId} — Eine einzelne Kampagnenvorlage. Operation getCampaignTemplate. Von einem KI-Assistenten: ja, über das MCP.
• PUT /v1/campaigns/templates/{templateId} — Eine Kampagnenvorlage bearbeiten. Operation updateCampaignTemplate. Von einem KI-Assistenten: ja, über das MCP.
• POST /v1/campaigns/unsubscribe — Eine Marketingliste verlassen. Kein Konto erforderlich. Operation unsubscribeFromCampaigns. Von einem KI-Assistenten: nur API und Dashboard: enthält ein Geheimnis, das niemals an ein KI-Modell gelangen darf (akzeptiert das signierte Abmelde-Token eines Empfängers).
• DELETE /v1/campaigns/{campaignId} — Eine Kampagne löschen und ihre Zustellungszeilen stilllegen. Operation deleteCampaign. Von einem KI-Assistenten: nur API und Dashboard: erfordert eine Berechtigung, die KI-Verbindungen nicht angeboten wird (das Löschen einer ESP-Kampagne erfordert campaigns.send).
• GET /v1/campaigns/{campaignId} — Eine Kampagne und ihr Zustellbericht. Operation getCampaign. Über einen KI-Assistenten: ja, über das MCP.
• POST /v1/campaigns/{campaignId}/control — Einen laufenden Versand anhalten, fortsetzen oder abbrechen. Operation controlCampaign. Über einen KI-Assistenten: nur API und Dashboard: Es verbraucht Geld oder Kontingent, daher betätigt dies eine Person (pausiert/setzt einen Live-Versand fort).
• POST /v1/campaigns/{campaignId}/send — Den dauerhaften Versand starten. Operation sendCampaign. Über einen KI-Assistenten: nur API und Dashboard: Es verbraucht Geld oder Kontingent, daher betätigt dies eine Person (sendet eine ESP-Kampagne an echte Empfänger).
• POST /v1/campaigns/{campaignId}/test — Eine echte Nachricht über den Kanal senden, den die Kampagne tatsächlich nutzen wird. Operation testSendCampaign. Über einen KI-Assistenten: nur API und Dashboard: Es ist eine Berechtigung erforderlich, die KI-Verbindungen nicht angeboten wird (ein ESP-Testversand erfordert campaigns.send).

Öffentliche Seiten und eingehende Webhooks

• GET /v1/public/email-marketing/c/{token} — Der Klick-Zähler. Erfasst einen Klick pro Empfänger und leitet zum ursprünglichen Link weiter. Operation emailMarketingClick. Über einen KI-Assistenten: eine Seite, die Ihre Empfänger über eine E-Mail öffnen (die Klick-Tracking-Weiterleitung).
• GET /v1/public/email-marketing/f/{public_id} — Die gehostete Seite eines Anmeldeformulars (keine Anmeldung erforderlich). Operation emailMarketingFormPage. Über einen KI-Assistenten: eine Seite, die Ihre Empfänger über eine E-Mail öffnen (die öffentliche Anmeldeformular-Seite).
• POST /v1/public/email-marketing/f/{public_id} — Ein Anmeldeformular senden (gehostete Seite, Einbettung oder JSON). Operation emailMarketingFormSubmit. Von einem KI-Assistenten: von einem anderen System aufgerufen (einem Anbieter oder einem Besucher), nicht von Ihnen (ein Besucher sendet ein Anmeldeformular).
• GET /v1/public/email-marketing/fc — Die Double-Opt-in-Bestätigungsseite (keine Anmeldung). Operation emailMarketingFormConfirmPage. Von einem KI-Assistenten: eine Seite, die Ihre Empfänger über eine E-Mail öffnen (die Double-Opt-in-Bestätigungsseite).
• POST /v1/public/email-marketing/fc — Eine Anmeldung bestätigen (fügt die Person mit einem Einwilligungsnachweis zur Liste hinzu). Operation emailMarketingFormConfirm. Von einem KI-Assistenten: von einem anderen System aufgerufen (einem Anbieter oder einem Besucher), nicht von Ihnen (ein Besucher bestätigt ein Double-Opt-in).
• GET /v1/public/email-marketing/o/{token} — Das Bild zur Öffnungsverfolgung (ein 1x1-GIF). Zählt eine Öffnung pro Empfänger. Operation emailMarketingOpenPixel. Von einem KI-Assistenten: eine Seite, die Ihre Empfänger über eine E-Mail öffnen (das Öffnungs-Tracking-Pixel).
• GET /v1/public/email-marketing/u/{token} — Der Abmeldelink in der Fußzeile (keine Anmeldung). Operation emailMarketingUnsubscribePage. Von einem KI-Assistenten: eine Seite, die Ihre Empfänger über eine E-Mail öffnen (die Abmeldeseite).
• POST /v1/public/email-marketing/u/{token} — RFC 8058 One-Click-Abmeldung (und die Schaltfläche „Alles stoppen“ der Seite). Operation emailMarketingUnsubscribeOneClick. Von einem KI-Assistenten: wird von einem anderen System (einem Anbieter oder einem Besucher) aufgerufen, nicht von Ihnen (RFC 8058 One-Click-Abmeldung).
• GET /v1/public/email-marketing/warmup-u/{token} — Der Abmeldelink für die Warm-up-E-Mail des Marketing-Pools (keine Anmeldung erforderlich). Operation emailMarketingWarmupUnsubscribePage. Von einem KI-Assistenten: eine Seite, die Ihre Empfänger über eine E-Mail öffnen (die Warm-up-Abmeldeseite).
• POST /v1/public/email-marketing/warmup-u/{token} — RFC 8058 One-Click-Abmeldung von der Warm-up-E-Mail. Operation emailMarketingWarmupUnsubscribeOneClick. Von einem KI-Assistenten: wird von einem anderen System (einem Anbieter oder einem Besucher) aufgerufen, nicht von Ihnen (Warm-up-One-Click-Abmeldung).
• POST /v1/webhooks/campaign-events — Einlesen eines signierten Zustellungsereignisses vom E-Mail-Anbieter. Operation receiveCampaignDeliveryWebhook. Von einem KI-Assistenten: wird von einem anderen System (einem Anbieter oder einem Besucher) aufgerufen, nicht von Ihnen (signierter ESP-Zustellungs-Webhook).
• POST /v1/webhooks/campaigns/telnyx — Eingehende SMS-Antworten (STOP / START) von unserem SMS-Anbieter. Operation receiveCampaignsTelnyxInbound. Von einem KI-Assistenten: wird von einem anderen System (einem Anbieter oder einem Besucher) aufgerufen, nicht von Ihnen (signierter eingehender Telnyx-Webhook).
• POST /v1/webhooks/email-marketing/{connection_id} — Zustellungsereignisse des eigenen E-Mail-Anbieters eines Kunden für eine Sendeverbindung. Operation receiveEmailMarketingProviderWebhook. Aus Sicht eines KI-Assistenten: von einem anderen System (einem Anbieter oder einem Besucher) aufgerufen, nicht von Ihnen (signierter Absender-Anbieter-Webhook).

Flows

• GET /v1/email-marketing/flows — E-Mail-Flows (Begrüßung, Drip, ein jährliches Datum), eine Keyset-Seite. Operation listEmailMarketingFlows. Geprüfte Berechtigungen: email_marketing.view. Aus Sicht eines KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/flows — Flow erstellen (beginnt als Entwurf). Operation createEmailMarketingFlow. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Aus Sicht eines KI-Assistenten: ja, über das MCP.
• DELETE /v1/email-marketing/flows/{flow_id} — Löschen Sie einen Flow und seine Registrierungen (seine gesendeten Durchläufe bleiben als Kampagnen erhalten). Operation deleteEmailMarketingFlow. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Aus Sicht eines KI-Assistenten: ja, über das MCP.
• GET /v1/email-marketing/flows/{flow_id} — Ein Flow mit seinen Schritten und seinem Bericht (registriert, in Bearbeitung, Durchläufe und Empfänger pro Schritt). Operation getEmailMarketingFlow. Geprüfte Berechtigungen: email_marketing.view. Aus Sicht eines KI-Assistenten: ja, über das MCP.
• PATCH /v1/email-marketing/flows/{flow_id} — Einen Ablauf ändern; steps, falls angegeben, ersetzt die gesamte Sequenz. Operation updateEmailMarketingFlow. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/flows/{flow_id}/activate — Einen Ablauf aktivieren; es werden nur Personen aufgenommen, die der Liste ab jetzt beitreten. Operation activateEmailMarketingFlow. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: ja, über das MCP.
• POST /v1/email-marketing/flows/{flow_id}/pause — Einen Ablauf pausieren; fällige Schritte warten und niemand Neues erhält E-Mails, bis er wieder aktiviert wird. Operation pauseEmailMarketingFlow. Geprüfte Berechtigungen: email_marketing.manage, email_marketing.view. Über einen KI-Assistenten: ja, über das MCP.