mail

PUT `/v1/mail/reseller-brand`

Set the mail hostnames this reseller's mail carries.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

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

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.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.

Tělo požadavku

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.

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 · 422 · 429

PUT /v1/mail/reseller-brand