GET /v1/mail/allowance
What the caller's plan grants for mailboxes.
Санҷиши ҳаққоният
Kaliti API-ро ҳамчун рамзи доранда (bearer token) фиристед. Калит бояд дорои иҷозати mail.view бошад; калиди бидуни он бо хатои 403 рад карда мешавад, на 404.
Ҷое, ки рақами мушаххаси ташкилоти шумо ҷойгир аст
Ин нуқтаи поёнӣ org_id-ро ҳамчун параметри дархостӣ қабул мекунад. Онро хориҷ кунед ва даъват тамоми зердарахти иҷораи шуморо фаро мегирад; барои маҳдуд кардани даъват ба як созмон онро фиристед.
Rakami муайянкунандаи ташкилоти шумо дар экрани калидҳои API дар панели идоракунии шумо, дар паҳлӯи худи калид ҷойгир аст. Ин як раками муайянкунанда дар ҳар یک дархосте, ки шумо иҷро мекунед, якхела аст.
Санҷидан
Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.
curl -X GET https://api.zinndigital.com/v1/mail/allowance \
-H "Authorization: Bearer zdk_live_…"Воarid шудаед? Консоли API дар панели идоракунии шумо рақами мушаххаси ташкилоти воқеӣ ва калиди худро пур мекунад ва дархостро бар зидди API-и фаъол иҷро мекунад, то шумо посухи воқеиро бубинед. Ин нуқтаи ниҳоиро дар консоли API кушоед
Тафсилот
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.
Параметрҳо
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
org_id (query) | Uuid | Не | The organization to resolve for; defaults to the caller's own when unambiguous. |
fqdn (query) | string | Не | Resolve for this hostname. Adds the domain source — free mailboxes on a domain we hold the registration for. |
Ҷавоб
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
offered_providers | MailProvider[] | Бале | 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… |
included | boolean | Бале | Whether the plan includes mailboxes at an operable size. |
box_quota_mb | integer | Бале | Per-mailbox size in MB. 0 means no per-mailbox cap. |
mailbox_limit | integer | Бале | 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 never… |
source | string<staff, subscription, trial, domain, free, none> | Бале | 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… |
Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад
401 · 403 · 422 · 429