API-Referenz

Ein einheitlicher Vertrag für die gesamte Kundenoberfläche.

Kunden-Endpunkte sind unter /api/v1 verfügbar. Das ältere Präfix /api bleibt für das Dashboard bestehen, neue Server-Integrationen sollten jedoch die versionierte Basis-URL verwenden.

63 dokumentierte Operationen8 RessourcengruppenOpenAPI 3.1 maschinenlesbarer Vertrag

Grenzen der Authentifizierung

Produktintegrationen nutzen einen Workspace-API-Schlüssel, der auch Kontonutzung, Analytics und Metadaten von API-Schlüsseln lesen kann. Änderungen an der Abrechnung sowie das Erstellen oder Widerrufen von API-Schlüsseln erfordern die HTTP-only-Browser-Sitzung und sind entsprechend gekennzeichnet.

Ressourcen

8 Operationen

E-Mails und Threads

E-Mails senden, abrufen, durchsuchen, beantworten und Zustell-Events einsehen.

8 Operationen

Labels und Ablageregeln

Gesendete und empfangene E-Mails automatisch oder manuell in Ordner einsortieren.

9 Operationen

Entwürfe und Anhänge

Composer-Abläufe mit privater Anhangspeicherung aufbauen.

10 Operationen

Gehostete Templates

Wiederverwendbare Inhalte entwerfen, rendern, testen, versionieren, veröffentlichen und senden.

7 Operationen

Domains

Absenderidentitäten anlegen und den Status der DNS-Verifizierung verstehen.

8 Operationen

Eingehende E-Mails

Adressen anlegen und mit empfangenen Konversationen arbeiten.

5 Operationen

Zustellbarkeit

Events, Reputationsergebnisse und blockierte Empfänger einsehen.

8 Operationen

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.

Fehlerobjekt

JSON-Fehler verwenden einen einheitlichen Envelope. Statuscodes unterscheiden ungültige Eingaben, Authentifizierung, fehlende Ressourcen, Konflikte, Zahlungsanforderungen, Sicherheitssperren und Nutzungslimits.

Fehlerantwort

{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

Versionierung

Die datumsbasierte API-Version kennzeichnet diesen Vertrag. Innerhalb der Version können abwärtskompatible Felder ergänzt werden. Breaking Changes erfordern einen neuen versionierten Basispfad und einen dokumentierten Übergang.

Discovery

{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}