GET /v1/mail/reseller-brand
The mail hostnames this reseller's mail is published and served under.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה mail.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/mail/reseller-brand \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Requires mail.view. An organization with no brand configured gets an empty one with configured: false rather than a 404 — the form is the same either way.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
org_id (query) | Uuid | לא | The organization to read for; defaults to the caller's own when unambiguous. |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
name | string | לא | What the reseller calls this brand, for their own screens. |
mx_hosts | string[] | כן | Apex MX targets in priority order, on the reseller's own domain, pointed at the relay's addresses. Their names — an A record they publish, never a CNAME to ours, which would put… |
spf_include | string | כן | The domain in the reseller's v=spf1 include:…. A delegation, so it must be a name whose SPF record they control and which in turn includes our sender list. |
autodiscover_host | string | כן | — |
imap_host | string | כן | — |
smtp_host | string | כן | — |
webmail_host | string | כן | Where the reseller's client's browser goes to read mail — the single most visible name in the whole product. |
configured | boolean | כן | Whether every hostname the preset needs has been supplied. All-or-nothing: a half-set would publish the reseller's MX beside the platform's SPF include, which is a leak and a… |
verified_at | string | לא | When these names were last confirmed to resolve to the relay. |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 429