mail

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

Set an auto-reply on a mailbox.

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

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

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

NázevTypPožadovánoCo to je
mailServiceId (path)UuidAnoEmail service ID (UUIDv7).

Tělo požadavku

NázevTypPožadovánoCo to je
localstringAnoThe mailbox to auto-reply for.
subjectstringNe
contentstringAno
start_timestringNeRFC 3339. Omit or null for no schedule - see MailResponder.
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