mail

PUT `/v1/mail/reseller-brand`

Set the mail hostnames this reseller's mail carries.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) mail.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`name`	`string`	Nem	What the reseller calls this brand, for their own screens.
`mx_hosts`	`string[]`	Igen	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`	Igen	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`	Igen	—
`imap_host`	`string`	Igen	—
`smtp_host`	`string`	Igen	—
`webmail_host`	`string`	Igen	Where the reseller's client's browser goes to read mail — the single most visible name in the whole product.

Válasz

Név	Típus	Kötelező	Mi ez
`name`	`string`	Nem	What the reseller calls this brand, for their own screens.
`mx_hosts`	`string[]`	Igen	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`	Igen	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`	Igen	—
`imap_host`	`string`	Igen	—
`smtp_host`	`string`	Igen	—
`webmail_host`	`string`	Igen	Where the reseller's client's browser goes to read mail — the single most visible name in the whole product.
`configured`	`boolean`	Igen	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`	Nem	When these names were last confirmed to resolve to the relay.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 422 · 429

PUT /v1/mail/reseller-brand