mail

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

Forward an address, a catch-all, or a whole domain.

Усі кінцеві точки mail

Уся документація для розробників

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

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

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

Спробувати

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

curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/forwarders \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "targets": <string[]> }'

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

Деталі

source is required for mailbox and ignored for catchall/wildcard, where the whole domain is the source — so it may be omitted for those rather than sending a value the backend discards. Requires mail.manage.

Параметри

НазваТипОбов'язковеЩо це таке
mailServiceId (path)UuidТакEmail service ID (UUIDv7).

Тіло запиту

НазваТипОбов'язковеЩо це таке
sourcestringНіRequired for mailbox; ignored for catchall/wildcard.
targetsstring[]Так
kindMailForwarderKindНіmailbox forwards one address; catchall takes anything not otherwise matched at the domain; wildcard forwards the whole domain to another one.

Відповідь

НазваТипОбов'язковеЩо це таке
idstringТакThe mail backend's identifier.
sourcestringТакThe local part being forwarded for mailbox; the domain itself for catchall/wildcard.
targetsstring[]ТакWhere mail goes. May include the backend's reserved drop/reject targets.
kindMailForwarderKindТакmailbox forwards one address; catchall takes anything not otherwise matched at the domain; wildcard forwards the whole domain to another one.

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

401 · 403 · 404 · 422 · 429 · 503