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.

163 documented operations11 resource groupsOpenAPI 3.1 machine-readable contract

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

10 operations

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.

9 operations

Zustellbarkeit

Events, Reputationsergebnisse und blockierte Empfänger einsehen.

10 operations

Webhooks

Receive signed, retried email events (sent, delivered, delayed, bounced, complained, failed, received) at your own endpoints.

47 operations

Campaigns

Store contacts with their consent basis, tags, and custom fields, organize them into lists with hosted double opt-in signup forms, welcome emails, and public newsletter sites, target segments, import and export CSV files, and send, test, and schedule broadcasts with merge tags, per-list one-click unsubscribe, pre-send checks, bot-filtered open and click reports, and per-recipient outcomes.

36 operations

Automations

Record what contacts do as events, and run timed sequences of emails that start on an event, stop when the contact converts, and share per-person sending limits. Create and edit automations, their emails and language versions, turn them on and off, and add or remove people. Available to enabled workspaces.

9 operations

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