GET /v1/mail/reseller-brand
The mail hostnames this reseller's mail is published and served under.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/mail/reseller-brand \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id (query) | Uuid | Ne | The organization to read for; defaults to the caller's own when unambiguous. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
name | string | Ne | What the reseller calls this brand, for their own screens. |
mx_hosts | string[] | Ano | 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 | Ano | 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 | Ano | — |
imap_host | string | Ano | — |
smtp_host | string | Ano | — |
webmail_host | string | Ano | Where the reseller's client's browser goes to read mail — the single most visible name in the whole product. |
configured | boolean | Ano | 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 | Ne | When these names were last confirmed to resolve to the relay. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 429