mail

PUT `/v1/mail/reseller-brand`

Set the mail hostnames this reseller's mail carries.

Аутентификација

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу mail.manage; кључ без ње се одбија уз 403, а не 404.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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 конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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