mailinapp
Documentation menu

Quickstart

Die transaktionale Send API lässt Ihr eigenes Backend eine E-Mail auslösen — genauso, wie Sie den Send-Endpunkt von Brevo, SendGrid oder Postmark aufrufen würden. Sie passt natürlich für OTPs, Belege und Benachrichtigungen, und sie kann auch ein im Studio gestaltetes Projekt auslösen, wobei Ihre eigenen Daten für eine Kontaktzeile stehen.

Einen Schlüssel prägen

Klicken Sie unter Entwickler im Dashboard auf Create key und geben Sie ihm einen Namen (z. B. „Produktions-Backend", „Staging"). Der vollständige Schlüssel — mia_live_... — wird genau einmal angezeigt. Bewahren Sie ihn sicher auf; MailInApp speichert nur einen Hash, es gibt also keine Möglichkeit, ihn erneut abzurufen. Falls Sie ihn verlieren, widerrufen Sie ihn und prägen Sie einen neuen.

Schlüssel sind auf Ihr Konto beschränkt, nicht auf ein einzelnes Projekt — ein Schlüssel kann jedes Projekt auslösen, das Ihnen gehört. Erstellen Sie so viele, wie Sie möchten (einer pro Umgebung oder Integration ist ein gängiges Muster), und widerrufen Sie jeden davon jederzeit unabhängig von den anderen.

Versand Nr. 1: Freiform

Für eine einfache transaktionale E-Mail — ohne beteiligtes Studio-Projekt — liefern Sie HTML und Text selbst:

curl -X POST https://mailinapp.com/api/v1/send \
  -H "Authorization: Bearer mia_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "to": "[email protected]",
    "subject": "Your one-time code",
    "html": "<p>Your code is 123456</p>",
    "text": "Your code is 123456"
  }'

Ein erfolgreicher Aufruf liefert:

{ "id": "abc123", "status": "sent" }

Versand Nr. 2: Vorlage

Das ist der eigentliche Unterschied: Gestalten Sie eine E-Mail visuell im Studio — Fallback-Engine, interaktive Blöcke, Merge-Tags — und lösen Sie sie dann aus Ihrem eigenen Anmelde-, Checkout- oder Support-Code aus, wobei mergeData für eine Datenquellen-Zeile steht:

curl -X POST https://mailinapp.com/api/v1/send \
  -H "Authorization: Bearer mia_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order_12345" \
  -d '{
    "to": "[email protected]",
    "projectId": "your-project-id",
    "mergeData": { "name": "Ada", "orderId": "12345" }
  }'

projectId finden Sie in der Studio-URL des Projekts (/studio/<projectId>). mergeData-Felder lösen sich in die {{field}}-Merge-Tags des Projekts auf, genau wie es eine Kontaktzeile täte. Der Empfänger erhält einen persönlichen, signierten Live-Ansicht-Link wie bei jedem anderen Versand — interaktive Blöcke (Abstimmungen, Bewertungen, Formulare) funktionieren, und jede Antwort fließt in die normale Antworten-Ansicht und Webhook-Zustellungen dieses Projekts, zugeordnet zu genau diesem API-Aufruf.

Der Header Idempotency-Key ist optional, aber empfohlen für alles, was durch eine wiederholbare Operation ausgelöst wird (ein Checkout-Webhook, ein Queue-Consumer) — siehe Idempotenz in der API-Referenz.

Den Absender überschreiben

Beide Versandarten verwenden standardmäßig die konfigurierte Absenderidentität Ihres Kontos — die Karte „From address" unter Einstellungen → Domains, falls Sie natives (SES-)Senden nutzen, oder ansonsten die Absenderadresse Ihres SMTP-Relays. Fügen Sie from hinzu, um sie für einen einzelnen Aufruf zu überschreiben, z. B. für ein Multi-Marken-Konto, das als bestimmtes Team sendet:

curl -X POST https://mailinapp.com/api/v1/send \
  -H "Authorization: Bearer mia_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "to": "[email protected]",
    "subject": "Your one-time code",
    "html": "<p>Your code is 123456</p>",
    "text": "Your code is 123456",
    "from": { "email": "[email protected]", "name": "Your Sales Team" }
  }'

from.email ist immer erforderlich, sobald from überhaupt vorhanden ist (kein reines Namens-Override); from.name ist optional. Bei nativem (SES-)Senden muss from.email eine Adresse auf einer Ihrer verifizierten Domains sein — siehe From address in der API-Referenz für den Grund und für die lockerere Regel bei SMTP.

Falls Sie bereits eine Absenderidentität im Dashboard gespeichert haben, übergeben Sie deren ID als senderId, statt Adresse/Name inline zu wiederholen — siehe die API-Referenz für beide Felder.

Nächste Schritte

  • Vollständige Request-/Response-Formen, type-Semantik, Rate Limits und Fehlercodes: API-Referenz.
  • Aktuelle Aufrufe mit Ihren Schlüsseln — einschließlich Status und etwaiger Fehler — erscheinen zur Prüfung auf der Seite Entwickler.
  • Noch kein SMTP-Relay vorhanden? Natives Senden lässt MailInApp in Ihrem Namen zustellen, sobald Ihre Domain zugelassen und verifiziert ist.
  • Möchten Sie stattdessen einen KI-Agenten Ihre E-Mails bauen oder bearbeiten lassen, statt die API direkt aufzurufen? Derselbe Schlüssel authentifiziert auch den MCP-Server, sodass Claude Desktop, Claude Code oder ein beliebiger anderer MCP-Client das per Chat für Sie erledigen kann.