mail

PUT `/v1/mail/reseller-brand`

Set the mail hostnames this reseller's mail carries.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл mail.manage; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`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.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`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 · 422 · 429

PUT /v1/mail/reseller-brand