GET /v1/mail/reseller-brand
The mail hostnames this reseller's mail is published and served under.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу mail.view; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/mail/reseller-brand \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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