GET /v1/mail/allowance
What the caller's plan grants for mailboxes.
Баталгаажуулалт
API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь mail.view эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.
Таны байгууллагын дугаар орох газар
Энэ төгсгөл цэг нь org_id-г асуулгын параметр болгон авдаг. Үүнийг орхивол дуудлага таны бүх түрээсийн дэд модыг хамрах бөгөөд дуудлагыг зөвхөн нэг байгууллагаар хязгаарлахын тулд үүнийг илгээнэ үү.
Танай байгууллагын ID нь таны хяналтын самбар дээрх API түлхүүрийн дэлгэцэнд, түлхүүр өөрөө хажууд байрладаг. Энэ нь таны хийх дуудлага бүрт ижил ID байна.
Туршиж үзэх
Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.
curl -X GET https://api.zinndigital.com/v1/mail/allowance \
-H "Authorization: Bearer zdk_live_…"Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй 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