API-Referenz

E-Mails und Threads

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

E-Mails und Threads filtern

POST/emails

API-Schlüssel

Eine E-Mail senden

Sendet transaktionale Inhalte als HTML, Text oder gehostetes Template von einer verifizierten Domain des Workspace. Direkte Sendungen können message_class auf marketing setzen, wenn dies für die verifizierte Absenderdomain aktiviert ist. Bei Marketing werden verwaltete Abmelde-Header hinzugefügt, sofern keine konfigurierte First-Party-Integration eine eigene sichtbare HTTPS-One-Click-URL liefert.

Optionale HeaderIdempotency-Key

Anfrage

curl https://sendhq.cc/api/v1/emails \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}'

Antwort 201

{
  "id": "em_…",
  "providerMessageId": "provider-id",
  "threadId": "em_…"
}

POST/emails/batch

API-Schlüssel

Bis zu 100 individualisierte Nachrichten senden

Optionale HeaderIdempotency-Key

Anfrage

curl https://sendhq.cc/api/v1/emails/batch \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":[{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}]}'

Antwort 201

{
  "data": [
    {
      "index": 0,
      "ok": true,
      "id": "em_…"
    }
  ],
  "count": 1,
  "successful": 1,
  "failed": 0
}

GET/emails

API-Schlüssel

Gesendete und empfangene E-Mails auflisten

Liste mit den neuesten zuerst, mit Filtern. `query` durchsucht Betreffzeilen, Inhalte, Beteiligte und Dateinamen von Anhängen. `label`, `domain` und `category` akzeptieren einen Wert oder eine kommagetrennte Liste (Treffer bei einem beliebigen Wert); Labels können IDs oder Namen sein. `archived=false` liefert die Posteingangsansicht für empfangene E-Mails. Empfangene E-Mails werden als `primary`, `updates` (Newsletter, Massen- und automatisierte E-Mails) oder `spam` klassifiziert und als `important` markiert; Spam ist ausgeschlossen, sofern nicht `category=spam` oder `include_spam=true` gesetzt ist.

Query-Parameterdirectionstatusdomaininbox_idlabelarchivedcategoryimportantinclude_spamfromtounreadafterbeforequerylimitoffset

Anfrage

curl https://sendhq.cc/api/v1/emails \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Antwort 200

{
  "data": [],
  "count": 0
}

GET/emails/:id

API-Schlüssel

Eine E-Mail mit ihren Anhängen abrufen

Anfrage

curl https://sendhq.cc/api/v1/emails/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Antwort 200

{
  "id": "em_…",
  "direction": "out",
  "status": "sent",
  "attachments": []
}

PATCH/emails/:id

API-Schlüssel

Gelesen-, Archiv-, Spam-, Kategorie- oder Wichtigkeitsstatus ändern

Setzt `read`, `archived`, `category` (`primary`, `updates` oder `spam` – nur bei empfangenen E-Mails) und `important`. Wenn Sie `category` oder `important` ändern, lernt SendHQ den Absender kennen: Als Spam gemeldete Absender landen künftig im Spam, `Not spam` hebt die automatischen Spamprüfungen für sie auf, und die Wichtigkeit bleibt am Absender haften. Übergeben Sie `learn: false`, um nur diese Nachricht zu ändern.

Anfrage

curl https://sendhq.cc/api/v1/emails/id_value \
  -X PATCH \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"spam"}'

Antwort 200

{
  "id": "em_…",
  "readAt": "2026-08-23T12:00:00.000Z",
  "archivedAt": null,
  "category": "spam",
  "important": false,
  "classification": "you moved it here"
}

DELETE/emails/:id

API-Schlüssel

Eine gespeicherte E-Mail löschen

Anfrage

curl https://sendhq.cc/api/v1/emails/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Antwort 200

{
  "ok": true
}

GET/emails/:id/events

API-Schlüssel

Zustell-Events einer E-Mail auflisten

Anfrage

curl https://sendhq.cc/api/v1/emails/id_value/events \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Antwort 200

{
  "data": [],
  "count": 0
}

GET/threads/:id

API-Schlüssel

Eine Konversation chronologisch abrufen

Anfrage

curl https://sendhq.cc/api/v1/threads/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Antwort 200

{
  "id": "em_…",
  "data": [],
  "count": 0
}