mail

PATCH `/v1/mail/routing/{fqdn}`

Re-point a forwarding domain's catch-all.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) mail.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X PATCH https://api.zinndigital.com/v1/mail/routing/{fqdn} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "destination": <string> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`fqdn (path)`	`string`	Igen	The hostname whose mail routing is being read or changed.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`destination`	`string`	Igen	Where mail to any address on this domain is delivered.

Válasz

Név	Típus	Kötelező	Mi ez
`fqdn`	`string`	Igen	The domain this routing is for.
`mechanism`	`string<zinn_mailbox, zinn_forward, cloudflare_routing, external, none>`	Igen	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`	Igen	Why this mechanism was chosen, in a sentence a person can act on.
`forwards`	`boolean`	Igen	Whether mail is passed on rather than stored.
`stores`	`boolean`	Igen	Whether this domain has real mailboxes on our relay.
`status`	`string<pending, converged, held, failed>`	Igen	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>`	Igen	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`	Igen	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`	Nem	When the world last agreed with the intended state.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429

PATCH /v1/mail/routing/{fqdn}