Zur Dokumentation springen
API

Eine Abwesenheitsnotiz einrichten

Die Antwort einer Adresse oder eines Catch-all speichern und dabei ersetzen, was gespeichert war.

PUT/out-of-office

Führt den echten Aufruf in Ihrem Workspace aus.

PUT /out-of-office

Die Antwort einer Adresse oder eines Catch-all speichern und dabei ersetzen, was gespeichert war.

Beispiel

Benötigt settings:write. address steht in der Query, und message ist das einzige Pflichtfeld: reiner Text mit 1 bis 10.000 Zeichen.

curl
curl -X PUT "$OE/[email protected]" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "startsAt": "2026-12-22T00:00:00Z",    "endsAt": "2027-01-04T08:00:00Z",    "subject": "Away until 4 January",    "message": "I am away until 4 January and will answer when I am back."  }'
Antwort
{  "object": "out_of_office",  "address": "[email protected]",  "enabled": true,  "active": true,  "startsAt": "2026-12-22T00:00:00.000Z",  "endsAt": "2027-01-04T08:00:00.000Z",  "subject": "Away until 4 January",  "message": "I am away until 4 January and will answer when I am back.",  "contactsOnly": false,  "updatedAt": "2026-12-22T09:14:03.117Z"}

Lassen Sie startsAt weg, um sofort zu beginnen oder um den Beginn einer Antwort zu behalten, die bereits an ist, und lassen Sie endsAt weg oder setzen Sie es auf null, damit die Antwort an bleibt, bis sie ausgeschaltet wird. subject nimmt höchstens 255 Zeichen, und bleibt es leer, trägt die Antwort Re: und den empfangenen Betreff. enabled: false behält den Text und pausiert die Antwort, und contactsOnly: true antwortet nur Kontakten und Personen, denen der Workspace geschrieben hat.

Jeder Absender bekommt die Antwort einmal für den gesamten Abwesenheitszeitraum, innerhalb desselben Threads, von der Adresse, an der die Mail ankam. startsAt zu ändern beginnt einen neuen Zeitraum, in dem allen noch einmal geantwortet wird, nur den Text oder endsAt zu ändern dagegen nicht. Ohne endsAt wird einem Absender nach 30 Tagen erneut geantwortet. Die Antwort trägt Auto-Submitted: auto-replied, kein Tracking und keine Signatur, zählt zu den monatlichen Sendungen und geht auch bei einem stummgeschalteten Thread hinaus.

Mail, die niemanden benachrichtigen würde, bekommt keine Antwort: Spam, Mail, die eine Regel in den Papierkorb verschoben hat, Newsletter und andere Massenmail, automatische Mail, Unzustellbarkeitsmeldungen, blockierte Absender und die eigenen Adressen des Workspace. Zuerst gilt die Antwort, die für die genaue Adresse gespeichert ist, dann die für die Adresse ohne ihren Plus-Tag, dann die des Catch-all, und ein Catch-all antwortet nie für eine Adresse, die jemand von Hand angelegt hat.

Ein 422 invalid_parameter bedeutet, dass address fehlt, keine Adresse des Workspace ist oder eine ganze Domain benennt, dass die Nachricht leer ist oder dass endsAt nicht nach startsAt liegt oder bereits vergangen ist. Nichts läuft über einen Timer: Die Daten werden geprüft, wenn Mail eintrifft.

Referenz