Set an out of office reply
Save the reply of one address or catch-all, replacing whatever was saved.
Runs the real call on your workspace.
PUT /out-of-office
Save the reply of one address or catch-all, replacing whatever was saved.
Example
Needs settings:write. address goes in the query, and message is the only required field: plain text of 1 to 10,000 characters.
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." }'{ "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"}Leave startsAt out to start now, or to keep the start of a reply that is already on, and leave endsAt out or null to keep the reply on until it is switched off. subject takes at most 255 characters, and left empty the reply answers with Re: and the subject received. enabled: false keeps the text and pauses the reply, and contactsOnly: true answers only contacts and people the workspace has written to.
Each sender gets the reply once for the whole away period, inside the same thread, from the address the mail arrived at. Changing startsAt begins a new period in which everyone is answered once more, and changing only the text or endsAt does not. With no endsAt a sender is answered again after 30 days. The reply carries Auto-Submitted: auto-replied, no tracking and no signature, counts toward the monthly sends, and still goes out on a muted thread.
Mail that would not alert anyone gets no reply: spam, mail a rule moved to the Bin, newsletters and other bulk mail, automatic mail, bounces, blocked senders and the workspace’s own addresses. The reply saved for the exact address applies first, then the one for the address without its plus-tag, then the catch-all’s, and a catch-all never answers for an address somebody created by hand.
A 422 invalid_parameter means address is missing, is not an address of the workspace or names a whole domain, the message is empty, or endsAt is not after startsAt or has already passed. Nothing runs on a timer: the dates are checked when mail arrives.