mail

PATCH /v1/mail/services/{mailServiceId}/responders/{responderId}

Edit an auto-reply.

Wszystkie punkty końcowe mail

Wszystkie dokumentacje dla programistów

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 PATCH https://api.zinndigital.com/v1/mail/services/{mailServiceId}/responders/{responderId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "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

Changes the message and its schedule. The address is not part of this body — an auto-reply belongs to a mailbox, and the address is which mailbox you are editing rather than a property of the reply. ⭐ This used to say "the mail backend has no rename verb". That was false and was the stated premise of a decision to offer no rename at all; measured against the live upstream hosting API on 2026-08-16, a mailbox renames in place, same id, contents intact. Use renameMailbox to change an address, or a forwarder to give a mailbox a second one. The responder is returned as the backend reports it back after the write, not as it was sent: the mail backend answers an applied update and an ignored one with the same empty body, so echoing the request would be a fabricated success (D9256). Requires mail.manage.

Parametry

NazwaTypWymaganeCo to jest
mailServiceId (path)UuidTakEmail service ID (UUIDv7).
responderId (path)stringTakThe mail backend's identifier for the responder, as returned by the list — not a UUID of ours. A responder has no model here, so there is no id of ours to use.

Treść żądania

NazwaTypWymaganeCo to jest
subjectstringNie
contentstringTak
start_timestringNieRFC 3339. null clears the schedule.
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 a…
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