POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
認証
ベアラー トークンとして API キーを送信します。キーには mail.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/responders \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "local": <string>, "content": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Idempotent on `local`: re-posting for the same mailbox reconciles to the existing responder rather than creating a second one, which is the backend's own natural key. Requires `mail.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
mailServiceId (path) | Uuid | はい | Email service ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
local | string | はい | The mailbox to auto-reply for. |
subject | string | いいえ | — |
content | string | はい | — |
start_time | string | いいえ | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | いいえ | RFC 3339, and must be after `start_time` when both are given. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | string | はい | The mail backend's identifier - the handle `DELETE` needs. |
local | string | はい | The part before the `@`. |
address | string | はい | The mailbox this replies for. |
subject | string | はい | — |
content | string | はい | The reply body. |
start_time | string | はい | When the auto-reply starts. `null` when unscheduled (it replies from now on). ⭐ This used to be declared **"Opaque - do not parse, compare or render as a date"** (#664), out of… |
end_time | string | はい | When the auto-reply stops. `null` to run until switched off. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503