mail

GET `/v1/mail/reseller-brand`

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

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar mail.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`org_id (query)`	`Uuid`	Hayır	The organization to read for; defaults to the caller's own when unambiguous.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`name`	`string`	Hayır	What the reseller calls this brand, for their own screens.
`mx_hosts`	`string[]`	Evet	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`	Evet	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`	Evet	—
`imap_host`	`string`	Evet	—
`smtp_host`	`string`	Evet	—
`webmail_host`	`string`	Evet	Where the reseller's client's browser goes to read mail — the single most visible name in the whole product.
`configured`	`boolean`	Evet	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`	Hayır	When these names were last confirmed to resolve to the relay.

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 429