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