mail

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

Edit an auto-reply.

Všechny koncové body mail

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

NázevTypPožadovánoCo to je
mailServiceId (path)UuidAnoEmail service ID (UUIDv7).
responderId (path)stringAnoThe 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.

Tělo požadavku

NázevTypPožadovánoCo to je
subjectstringNe
contentstringAno
start_timestringNeRFC 3339. null clears the schedule.
end_timestringNeRFC 3339, and must be after start_time when both are given.

Odpověď

NázevTypPožadovánoCo to je
idstringAnoThe mail backend's identifier - the handle DELETE needs.
localstringAnoThe part before the @.
addressstringAnoThe mailbox this replies for.
subjectstringAno
contentstringAnoThe reply body.
start_timestringAnoWhen 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_timestringAnoWhen the auto-reply stops. null to run until switched off.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429 · 503