POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar mail.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
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> }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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`.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
mailServiceId (path) | Uuid | Evet | Email service ID (UUIDv7). |
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
local | string | Evet | The mailbox to auto-reply for. |
subject | string | Hayır | — |
content | string | Evet | — |
start_time | string | Hayır | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Hayır | RFC 3339, and must be after `start_time` when both are given. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | string | Evet | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Evet | The part before the `@`. |
address | string | Evet | The mailbox this replies for. |
subject | string | Evet | — |
content | string | Evet | The reply body. |
start_time | string | Evet | 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 | Evet | When the auto-reply stops. `null` to run until switched off. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 422 · 429 · 503