mail

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

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

Всички крайни точки в mail

Всички документи за разработчици

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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.

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429 · 503