GET /v1/mail/reseller-brand
The mail hostnames this reseller's mail is published and served under.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/mail/reseller-brand \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
org_id (query) | Uuid | Nie | The organization to read for; defaults to the caller's own when unambiguous. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
name | string | Nie | What the reseller calls this brand, for their own screens. |
mx_hosts | string[] | Tak | 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 | Tak | 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 | Tak | — |
imap_host | string | Tak | — |
smtp_host | string | Tak | — |
webmail_host | string | Tak | Where the reseller's client's browser goes to read mail — the single most visible name in the whole product. |
configured | boolean | Tak | 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 | Nie | When these names were last confirmed to resolve to the relay. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 429