Basis-URL: steht auf der API-Seite Ihres Projekts. Jede Anfrage authentifizieren Sie mit
Authorization: Bearer <API-Schlüssel>.
| Methode |
Pfad |
Zweck |
POST |
/v1/emails |
Nachricht einliefern. Verlangt Idempotency-Key. |
GET |
/v1/emails/{id} |
Status und Verlauf einer Nachricht lesen. Braucht einen Schlüssel mit Leserecht. |
POST |
/v1/emails/{id}/cancel |
Eine noch nicht gesendete Nachricht abbrechen. |
GET |
/v1/usage |
Verbrauch und verbleibendes Kontingent lesen. |
Schlüssel sind entweder nur Senden oder Senden, Lesen und Verbrauch. Mit einem Nur-Senden-
Schlüssel können Sie keinen Status abfragen; nutzen Sie dafür das Dashboard.
| Feld |
Pflicht |
Hinweis |
stream_id |
ja |
UUID von der API-Seite des Projekts |
from |
ja |
{ email, name? }; muss Ihrem freigegebenen Absender entsprechen |
to |
ja |
Genau ein { email, name? } |
subject |
ja |
Bis zu 998 Zeichen |
text / html |
mindestens eines |
Inhalt |
reply_to |
nein |
Genau ein { email, name? } |
expires_at |
nein |
ISO-8601-Zeitpunkt; danach kein Versand |
tags |
nein |
Bis zu 10 Schlüssel (1–64 Zeichen), Werte bis 256 Zeichen |
| Code |
Bedeutung |
202 |
Gespeichert und eingereiht (oder als gesperrt protokolliert). Noch nicht zugestellt. |
400 |
Fehlerhafte Anfrage. |
401 |
Schlüssel fehlt, ist falsch oder abgelaufen. |
403 |
Der Schlüssel darf das nicht, etwa falscher Absender oder fehlendes Recht. |
404 |
Nachricht oder Stream für diesen Schlüssel nicht gefunden. |
409 |
Konflikt, etwa ein Idempotency-Key mit anderem Inhalt. |
413 |
Nachricht zu groß. |
422 |
Gültiges JSON, das nicht angenommen werden kann, etwa ein nicht freigegebener Absender. |
429 |
Ratenlimit oder Kontingent erreicht. |
503 |
Vorübergehend nicht verfügbar oder Ergebnis unklar. Mit demselben Key und Body wiederholen. |