mail

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

Set an auto-reply on a mailbox.

Wszystkie punkty końcowe mail

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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> }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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`.

Parametry

NazwaTypWymaganeCo to jest
mailServiceId (path)UuidTakEmail service ID (UUIDv7).

Treść żądania

NazwaTypWymaganeCo to jest
localstringTakThe mailbox to auto-reply for.
subjectstringNie
contentstringTak
start_timestringNieRFC 3339. Omit or `null` for no schedule - see `MailResponder`.
end_timestringNieRFC 3339, and must be after `start_time` when both are given.

Odpowiedź

NazwaTypWymaganeCo to jest
idstringTakThe mail backend's identifier - the handle `DELETE` needs.
localstringTakThe part before the `@`.
addressstringTakThe mailbox this replies for.
subjectstringTak
contentstringTakThe reply body.
start_timestringTakWhen 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_timestringTakWhen the auto-reply stops. `null` to run until switched off.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422 · 429 · 503