ドキュメント本文へスキップ
API

不在通知を設定する

1 つのアドレスまたはキャッチオールの返信を保存し、保存済みのものがあれば置き換えます。

PUT/out-of-office

実際の呼び出しをワークスペースに対して実行します。

PUT /out-of-office

1 つのアドレスまたはキャッチオールの返信を保存し、保存済みのものがあれば置き換えます。

例

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 は連絡先と、ワークスペースからメールを書いたことのある相手にだけ返信します。

各送信者は、不在期間全体で 1 回だけ、同じスレッドの中で、メールが届いたアドレスから返信を受け取ります。startsAt を変更すると新しい期間が始まり、全員にもう一度返信しますが、テキストや endsAt だけを変更しても新しい期間は始まりません。endsAt がない場合は 30 日後に同じ送信者へもう一度返信します。返信には Auto-Submitted: auto-replied が付き、トラッキングも署名も付かず、月間の送信数に数えられ、ミュート中のスレッドでも送られます。

誰にも通知されないメールには返信しません。迷惑メール、ルールがごみ箱に移したメール、ニュースレターなどの一括送信メール、自動送信メール、バウンス、ブロックした送信者、ワークスペース自身のアドレスがこれに当たります。まずそのアドレスそのものに保存された返信が使われ、次にプラスタグを除いたアドレスの返信、その次にキャッチオールの返信が使われます。誰かが手で作成したアドレスの代わりにキャッチオールが返信することはありません。

422 invalid_parameter は、address がない、ワークスペースのアドレスではない、またはドメイン全体を指している場合、メッセージが空の場合、endsAt が startsAt より後でないか、すでに過ぎている場合を意味します。タイマーで動くものはなく、日付はメールが届いたときに確認されます。

リファレンス