mail

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

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

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл mail.manage; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`fqdn (path)`	`string`	Так	The hostname whose mail routing is being read or changed.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`destination`	`string`	Так	Where mail to any address on this domain is delivered.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`fqdn`	`string`	Так	The domain this routing is for.
`mechanism`	`string<zinn_mailbox, zinn_forward, cloudflare_routing, external, none>`	Так	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`	Так	Why this mechanism was chosen, in a sentence a person can act on.
`forwards`	`boolean`	Так	Whether mail is passed on rather than stored.
`stores`	`boolean`	Так	Whether this domain has real mailboxes on our relay.
`status`	`string<pending, converged, held, failed>`	Так	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>`	Так	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`	Так	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`	Ні	When the world last agreed with the intended state.

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422 · 429

PATCH /v1/mail/routing/{fqdn}