Перейти к документации
API

Задать ответ автоответчика

Сохранить ответ одного адреса или catch-all, заменив то, что было сохранено.

PUT/out-of-office

Выполняет настоящий запрос в вашем рабочем пространстве.

PUT /out-of-office

Сохранить ответ одного адреса или catch-all, заменив то, что было сохранено.

Пример

Требуется settings:write. address передаётся в строке запроса, а обязательное поле только одно, message: обычный текст длиной от 1 до 10 000 символов.

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."  }'
Ответ
{  "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"}

Не передавайте startsAt, чтобы начать сейчас или сохранить начало уже включённого ответа, и не передавайте endsAt или задайте null, чтобы ответ оставался включённым, пока его не выключат. subject принимает не более 255 символов, а если он пуст, в ответе стоит Re: и полученная тема. enabled: false сохраняет текст и приостанавливает ответ, а с contactsOnly: true ответ получают только контакты и люди, которым рабочее пространство писало.

Каждый отправитель получает ответ один раз за весь период отсутствия, в той же цепочке, с адреса, на который пришло письмо. Изменение startsAt открывает новый период, в котором каждый получает ответ ещё раз, а изменение только текста или endsAt его не открывает. Без endsAt отправитель снова получает ответ через 30 дней. Ответ содержит Auto-Submitted: auto-replied, уходит без отслеживания и без подписи, идёт в счёт месячных отправок и всё равно уходит в игнорируемой цепочке.

На почту, которая никого бы не оповестила, ответ не отправляется: это спам, письма, которые правило переместило в корзину, рассылки и прочая массовая почта, автоматическая почта, отчёты о невозможности доставки, заблокированные отправители и собственные адреса рабочего пространства. Сначала применяется ответ, сохранённый для точного адреса, затем ответ для адреса без плюс-тега, затем ответ catch-all, причём catch-all никогда не отвечает за адрес, который кто-то создал вручную.

422 invalid_parameter означает, что address не передан, не является адресом рабочего пространства или называет целый домен, что сообщение пусто либо что endsAt не позже startsAt или уже прошёл. Ничего не работает по таймеру: даты проверяются, когда приходит почта.

Справочник