Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão mail.view; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/mail/allowance \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id (query) | Uuid | Não | The organization to resolve for; defaults to the caller's own when unambiguous. |
fqdn (query) | string | Não | Resolve for this hostname. Adds the `domain` source — free mailboxes on a domain we hold the registration for. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
offered_providers | MailProvider[] | Sim | 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 | Sim | Whether the plan includes mailboxes at an operable size. |
box_quota_mb | integer | Sim | Per-mailbox size in MB. `0` means no per-mailbox cap. |
mailbox_limit | integer | Sim | 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> | Sim | 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… |
Erros que este endpoint pode retornar
401 · 403 · 422 · 429