Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda mail.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ibùdó àmì ìdánimọ̀ ilé-iṣẹ́ rẹ sí
Oju-iwọle yii nlo org_id gẹgẹbi ayẹwo ibeere. Fi silẹ ni ita yoo si bo igi iyalo rẹ lapapọ; ranṣẹ si lati dín ibeere naa kù si ajọ kan.
Id àjọ rẹ wa lórí ojú-ìwákòòkò àwọn bọ́tìnnì API nínú daṣibọọdú rẹ, lẹ́gbẹ̀ẹ́ bọ́tìnnì náà gan-an. Ó jẹ́ ìd kan náà nínú gbogbo ìpè tí o bá ṣe.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X GET https://api.zinndigital.com/v1/mail/allowance \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
The preflight the "set up email" screen reads: whether the governing plan includes mailboxes, how large each one is, and how many a domain may have. **Reports rather than refuses** — an organization with no plan gets `included: false` and an upgrade prompt, not an error, because this is a read screen. Resolution walks **up** the `parent_org` chain, so a reseller's client organization inherits the reseller's plan (CLAUDE.md §2.3). `source` names where the answer came from. `mailbox_limit` is the **smaller of the plan's `mailboxes` grant and the platform abuse ceiling**, so it does vary by plan; `-1` means both are uncapped. Requires `mail.view`. ⭐ **Pass `fqdn` whenever the question is about one domain, which is nearly always.** Since the owner's ruling of 2026-08-16 a domain registered with us — or transferred in — grants free mailboxes **on itself**, whatever the organization's hosting plan says, and that grant is only reachable when the hostname is supplied. Without `fqdn` this endpoint answers the narrower question "does anything the organization owns include mail at all", and a customer whose only product is a domain gets `included: false` followed by a successful mailbox creation — a screen disagreeing with its own API.
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
org_id (query) | Uuid | Bẹẹkọ | The organization to resolve for; defaults to the caller's own when unambiguous. |
fqdn (query) | string | Bẹẹkọ | Resolve for this hostname. Adds the `domain` source — free mailboxes on a domain we hold the registration for. |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
offered_providers | MailProvider[] | Bẹẹni | The providers this organization may set a domain up on, in picker order — **the one producer of the white-label rule** (W40-MAIL). `zinn` is absent, not disabled, for an organiz… |
included | boolean | Bẹẹni | Whether the plan includes mailboxes at an operable size. |
box_quota_mb | integer | Bẹẹni | Per-mailbox size in MB. `0` means no per-mailbox cap. |
mailbox_limit | integer | Bẹẹni | Mailboxes allowed per domain; `-1` is uncapped. The **smaller** of the plan's `mailboxes` grant and the platform abuse ceiling: a plan may lower it, and a generous plan can neve… |
source | string<staff, subscription, trial, domain, none> | Bẹẹni | Where the allowance came from. `domain` means **the domain itself grants it** — it is registered with us or was transferred in, so its mailboxes are free whatever the organizati… |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 422 · 429