mail

PUT /v1/mail/reseller-brand

Set the mail hostnames this reseller's mail carries.

Wszystkie punkty końcowe mail

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X PUT https://api.zinndigital.com/v1/mail/reseller-brand \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "mx_hosts": <string[]>, "spf_include": <string>, "autodiscover_host": <string>, "imap_host": <string>, "smtp_host": <string>, "webmail_host": <string> }'

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.manage. Every field is a public hostname — there is no credential here, because the relay authenticates the mailbox rather than the brand. ⭐ This is what makes hosted mail sellable by a white-label reseller. With their own mx1. / imap. / smtp. / webmail. names in front of the relay, nothing published on a client's zone and nothing handed to a client's mail app carries the platform's name — so the product can be offered without the leak that previously required withholding it. ⛔ A partially-filled brand is saved and does not enable anything. configured is all-or-nothing: a brand with an MX and no webmail host would publish the reseller's MX and then send their client to somebody else's webmail, which is the leak arriving through the mechanism built to close it.

Treść żądania

NazwaTypWymaganeCo to jest
namestringNieWhat the reseller calls this brand, for their own screens.
mx_hostsstring[]TakApex 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_includestringTakThe 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_hoststringTak
imap_hoststringTak
smtp_hoststringTak
webmail_hoststringTakWhere the reseller's client's browser goes to read mail — the single most visible name in the whole product.

Odpowiedź

NazwaTypWymaganeCo to jest
namestringNieWhat the reseller calls this brand, for their own screens.
mx_hostsstring[]TakApex 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_includestringTakThe 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_hoststringTak
imap_hoststringTak
smtp_hoststringTak
webmail_hoststringTakWhere the reseller's client's browser goes to read mail — the single most visible name in the whole product.
configuredbooleanTakWhether 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_atstringNieWhen these names were last confirmed to resolve to the relay.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 422 · 429