mail

POST `/v1/mail/services/{mailServiceId}/responders`

Set an auto-reply on a mailbox.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز mail.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی 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 a…
`end_time`	`string`	بله	When the auto-reply stops. `null` to run until switched off.

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 422 · 429 · 503

POST /v1/mail/services/{mailServiceId}/responders