API-Referenz
Konto und Abrechnung
Mit einem API-Schlüssel lesen Sie Kontonutzung, Analytics und Schlüssel-Metadaten. Änderungen an der Abrechnung sowie das Erstellen oder Widerrufen von Schlüsseln erfordern eine Dashboard-Sitzung.
Keine Operationen entsprechen diesem Filter.
/accountKonto, Nutzung, Abrechnungsstatus und Workspace-Anzahl mit einem API-Schlüssel abrufen
API-Schlüssel-Pendant zum Dashboard-Profil: Kontoinhaber, Empfänger- und Anhangnutzung im aktuellen Zeitraum im Verhältnis zu den Tariflimits, Zugriffsstufe, Zusammenfassung der Absenderreputation, Abonnementstatus, veröffentlichte Tarife und Workspace-Anzahl. Nur lesend; Änderungen an der Abrechnung bleiben der Sitzung vorbehalten.
curl https://sendhq.cc/api/v1/account \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"infrastructure": {},
"billing": {},
"plans": [],
"workspace": {
"mailer": "ses",
"stats": {}
}
}/account/diagnosticsDiagnose sending and receiving problems in the workspace
Read-only troubleshooting snapshot from stored state: an `issues` list in plain language, plan and usage against limits, each domain's DKIM and inbound state, sending identities, 30-day deliverability and sender reputation, suppressions and unsubscribes, the last 30 days of messages that were not sent with their reasons, bounce, complaint and reject events, and webhook delivery health. Never returns message bodies, API keys or webhook secrets.
curl https://sendhq.cc/api/v1/account/diagnostics \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"generatedAt": "2026-10-30T12:00:00.000Z",
"windowDays": 30,
"issues": [
{
"severity": "action",
"code": "domain_unverified",
"message": "example.com is not verified (pending); 2 of 3 DKIM records are not visible in DNS yet."
}
],
"plan": {},
"domains": [],
"sendingIdentities": {
"domains": [],
"addresses": []
},
"inbound": {},
"deliverability": {},
"suppressions": {},
"failures": {
"notSent": [],
"recentNotSent": [],
"recentProviderEvents": []
},
"webhooks": []
}/analyticsSende-Analytics des Dashboards für 7, 30 oder 90 Tage abrufen
Summen für gesendete, empfangene, zugestellte, gebouncte, blockierte, geöffnete, angeklickte E-Mails und Beschwerden im Zeitraum, eine Tages-Timeline für gesendete/empfangene E-Mails, die Top-Absenderdomains und die erfolgreichsten Betreffzeilen.
curl https://sendhq.cc/api/v1/analytics \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"window": "30d",
"days": 30,
"metrics": {
"sent": 0,
"received": 0,
"bounced": 0,
"blocked": 0,
"delivered": 0,
"opened": 0,
"clicks": 0,
"complaints": 0
},
"timeline": [],
"domains": [],
"topContent": []
}/profileKonto, Nutzung und gestapelten Abonnementstatus abrufen
Konto, Nutzung und gestapelten Abonnementstatus abrufen
curl https://sendhq.cc/api/v1/profile \
-X GET \
-H "Cookie: sendhq_session_v2=…"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"billing": {},
"plans": []
}/billing/checkoutGehosteten Checkout für einen noch nicht gebuchten Tarif starten (Stufe, Nachrichtenklasse und Abrechnungsintervall)
Gehosteten Checkout für einen noch nicht gebuchten Tarif starten (Stufe, Nachrichtenklasse und Abrechnungsintervall)
curl https://sendhq.cc/api/v1/billing/checkout \
-X POST \
-H "Cookie: sendhq_session_v2=…" \
-H "Content-Type: application/json" \
-d '{"plan_key":"scaleup_marketing_annual"}'{
"url": "https://checkout.example/…",
"session_id": "…"
}/billing/cancelAktuelles Abonnement in der App kündigen, ohne den Provider anzutasten
Aktuelles Abonnement in der App kündigen, ohne den Provider anzutasten
curl https://sendhq.cc/api/v1/billing/cancel \
-X POST \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}/keysAPI-Schlüssel erstellen
API-Schlüssel erstellen
curl https://sendhq.cc/api/v1/keys \
-X POST \
-H "Cookie: sendhq_session_v2=…" \
-H "Content-Type: application/json" \
-d '{"name":"Production"}'{
"id": "key_…",
"name": "Production",
"key": "re_…",
"prefix": "re_…"
}/keysMetadaten von API-Schlüsseln auflisten
Listet Schlüsselnamen, nicht geheime Präfixe und Zeitstempel der letzten Nutzung auf. Vollständige Schlüsselwerte werden nie zurückgegeben. Zum Erstellen und Widerrufen von Schlüsseln ist eine Dashboard-Sitzung erforderlich.
curl https://sendhq.cc/api/v1/keys \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}/keys/:idAPI-Schlüssel widerrufen
API-Schlüssel widerrufen
curl https://sendhq.cc/api/v1/keys/id_value \
-X DELETE \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}