ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ
បញ្ជូនសោ API ជា bearer token។ សោនេះត្រូវតែមានសិទ្ធិ mail.view។ សោដែលគ្មានសិទ្ធិនេះនឹងត្រូវបដិសេធដោយកូដ 403 មិនមែន 404 ទេ។
កន្លែងដែលលេខសម្គាល់អង្គការរបស់អ្នកត្រូវដាក់
ចំណុចប្រទាក់នេះទទួលយក org_id ជាប៉ារ៉ាម៉ែត្រសំណួរ។ សូមទុកវាចោល ហើយការហៅនេះនឹងគ្របដណ្តប់លើដើមឈើភតិកៈទាំងមូលរបស់អ្នក; សូមបញ្ជូនវាដើម្បីកំណត់ការហៅឱ្យចង្អៀតមកត្រឹមអង្គការតែមួយ។
លេខសម្គាល់អង្គការរបស់អ្នកស្ថិតនៅលើអេក្រង់គ្រាប់ចុច API ក្នុងផ្ទាំងគ្រប់គ្រងរបស់អ្នក នៅជាប់នឹងគ្រាប់ចុចផ្ទាល់តែម្ដង។ វាគឺជាលេខសម្គាល់ដូចគ្នានៅក្នុងការហៅទូរសព្ទនីមួយៗដែលអ្នកធ្វើ។
សាកល្បង
ជំនួសអ្វីមួយនៅក្នុងសញ្ញាពងក្រពើ < > ដោយប្រើតម្លៃផ្ទាល់ខ្លួនរបស់អ្នក ហើយជំនួសកន្លែងរក្សាទុកសោដោយប្រើសោចេញពីផ្ទាំងគ្រប់គ្រងរបស់អ្នក។
curl -X GET https://api.zinndigital.com/v1/mail/allowance \
-H "Authorization: Bearer zdk_live_…"បានចូលគណនីរួចហើយមែនទេ? កុងសូល 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 organiz… |
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 neve… |
source | string<staff, subscription, trial, domain, 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 organizati… |
កំហុសដែលចំណុចបញ្ចប់នេះអាចបង្វិលត្រឡប់មកវិញ
401 · 403 · 422 · 429