PATCH /v1/mail/routing/{fqdn}
Re-point a forwarding domain's catch-all.
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/routing/{fqdn} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "destination": <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
Sets where everything addressed to this domain is delivered. Requires mail.manage. ⛔ Taking ownership is part of the write. The alias stops being system-managed, so the convergence sweep will never reassert our computed destination over the customer's choice — silently, which is the only way that failure would ever be noticed. ⛔ Refused with 422 on a domain that stores its mail in mailboxes, rather than accepted and ignored: a forwarding address on a mailbox domain is a control that appears to work while mail keeps arriving in the mailbox.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
fqdn (path) | string | Tak | The hostname whose mail routing is being read or changed. |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
destination | string | Tak | Where mail to any address on this domain is delivered. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
fqdn | string | Tak | The domain this routing is for. |
mechanism | string<zinn_mailbox, zinn_forward, cloudflare_routing, external, none> | Tak | Which mechanism serves this domain's inbound mail. zinn_mailbox stores it; zinn_forward and cloudflare_routing pass it on and store nothing; external means the customer's… |
mechanism_label | string | Tak | Why this mechanism was chosen, in a sentence a person can act on. |
forwards | boolean | Tak | Whether mail is passed on rather than stored. |
stores | boolean | Tak | Whether this domain has real mailboxes on our relay. |
status | string<pending, converged, held, failed> | Tak | The last convergence pass's outcome. held is distinct from failed and means the zone could not be read, so nothing was changed — which is correct behaviour, not a fault. |
dns_authority | string<cloudflare, other, unknown> | Tak | Whose nameservers the zone was delegated to when last measured. unknown means the lookup did not answer — never that it is delegated elsewhere. |
catch_all | string | Tak | Where mail to any address on this domain is delivered. Empty when no forwarding alias exists — a domain with no deliverable destination gets no alias rather than one pointing… |
last_converged_at | string | Nie | When the world last agreed with the intended state. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422 · 429