POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Doğrulama
API açarını bearer token kimi göndərin. Açar mail.manage icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
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> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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`.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
mailServiceId (path) | Uuid | Bəli | Email service ID (UUIDv7). |
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
local | string | Bəli | The mailbox to auto-reply for. |
subject | string | Xeyr | — |
content | string | Bəli | — |
start_time | string | Xeyr | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Xeyr | RFC 3339, and must be after `start_time` when both are given. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | string | Bəli | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Bəli | The part before the `@`. |
address | string | Bəli | The mailbox this replies for. |
subject | string | Bəli | — |
content | string | Bəli | The reply body. |
start_time | string | Bəli | 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 | Bəli | When the auto-reply stops. `null` to run until switched off. |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422 · 429 · 503