API-Referenz

Labels und Ablageregeln

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

Labels und Ablageregeln filtern

POST/emails/:id/labels

API-Schlüssel

Labels einer E-Mail hinzufügen oder entfernen

Fügen Sie Labels per Name oder lbl_-ID hinzu oder entfernen Sie sie. Unbekannte Namen in `add` werden angelegt, sofern `create` nicht false ist. Eine E-Mail kann höchstens 10 Labels tragen.

Anfrage

curl https://sendhq.cc/api/v1/emails/id_value/labels \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"add":["Billing"],"remove":["Support"]}'

Antwort 200

{
  "id": "em_…",
  "labels": [
    {
      "id": "lbl_…",
      "name": "Billing",
      "color": "#188038"
    }
  ]
}

GET/labels

API-Schlüssel

Labels mit Nachrichtenanzahl und Ablageregeln auflisten

Anfrage

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

Antwort 200

{
  "data": [],
  "count": 0,
  "mailbox": {
    "inboxUnread": 0,
    "updatesUnread": 0,
    "spamTotal": 0,
    "importantUnread": 0,
    "resortPending": 0
  }
}

POST/labels

API-Schlüssel

Label anlegen, optional mit Regeln zur automatischen Ablage

Legt ein Label im Stil eines Ordners an. Setzen Sie `skip_inbox: true`, um daraus einen Bucket zu machen: Empfangene E-Mails, die dieses Label erhalten (durch eine Regel, durch eine Antwort auf eine mit dem Label gesendete Konversation oder manuell), werden archiviert und erscheinen nur im Label, nie im Posteingang. Optionale `rules` legen neue gesendete oder empfangene E-Mails automatisch ab: Jede in einer Regel gesetzte Bedingung muss zutreffen (inbox_id, direction sowie Teilzeichenfolgen in from/to/subject ohne Beachtung der Groß-/Kleinschreibung). Setzen Sie `apply_to_existing`, um auch bereits gespeicherte E-Mails abzulegen.

Anfrage

curl https://sendhq.cc/api/v1/labels \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Agent/Orders","color":"#188038","skip_inbox":true,"rules":[{"inbox_id":"inb_…"}],"apply_to_existing":true}'

Antwort 201

{
  "id": "lbl_…",
  "name": "Agent/Orders",
  "color": "#188038",
  "skipInbox": true,
  "totalCount": 0,
  "unreadCount": 0,
  "rules": []
}

GET/labels/:id

API-Schlüssel

Label per ID oder Name abrufen

Anfrage

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

Antwort 200

{
  "id": "lbl_…",
  "name": "Billing",
  "color": "#188038",
  "skipInbox": false,
  "totalCount": 0,
  "unreadCount": 0,
  "rules": []
}

PATCH/labels/:id

API-Schlüssel

Label umbenennen, umfärben oder in einen Bucket umwandeln

Ändert `name`, `color` oder `skip_inbox`. Wenn Sie `skip_inbox` aktivieren, werden auch bereits im Label vorhandene empfangene E-Mails archiviert, sofern `apply_to_existing` nicht false ist.

Anfrage

curl https://sendhq.cc/api/v1/labels/id_value \
  -X PATCH \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Finance/Billing","color":"#1a73e8","skip_inbox":true}'

Antwort 200

{
  "id": "lbl_…",
  "name": "Finance/Billing",
  "color": "#1a73e8",
  "skipInbox": true
}

DELETE/labels/:id

API-Schlüssel

Label löschen, ohne dessen E-Mails zu löschen

Anfrage

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

Antwort 200

{
  "ok": true
}

POST/labels/:id/rules

API-Schlüssel

Regel zur automatischen Ablage zu einem Label hinzufügen

Anfrage

curl https://sendhq.cc/api/v1/labels/id_value/rules \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"direction":"in","from":"@stripe.com","subject":"invoice","skip_inbox":true,"apply_to_existing":false}'

Antwort 201

{
  "id": "lrule_…",
  "labelId": "lbl_…",
  "direction": "in",
  "inboxId": null,
  "from": "@stripe.com",
  "to": null,
  "subject": "invoice",
  "skipInbox": true
}

DELETE/labels/:id/rules/:rule_id

API-Schlüssel

Regel zur automatischen Ablage löschen

Anfrage

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

Antwort 200

{
  "ok": true
}