mail

GET `/v1/mail/reseller-brand`

The mail hostnames this reseller's mail is published and served under.

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu mail.view; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X GET https://api.zinndigital.com/v1/mail/reseller-brand \
  -H "Authorization: Bearer zdk_live_…"

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

Requires mail.view. An organization with no brand configured gets an empty one with configured: false rather than a 404 — the form is the same either way.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`org_id (query)`	`Uuid`	Ne	The organization to read for; defaults to the caller's own when unambiguous.

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`name`	`string`	Ne	What the reseller calls this brand, for their own screens.
`mx_hosts`	`string[]`	Da	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`	Da	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`	Da	—
`imap_host`	`string`	Da	—
`smtp_host`	`string`	Da	—
`webmail_host`	`string`	Da	Where the reseller's client's browser goes to read mail — the single most visible name in the whole product.
`configured`	`boolean`	Da	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.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 429