mail

PUT `/v1/mail/mailboxes/{mailboxId}`

Change a mailbox's size, or its send/receive switches.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão mail.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

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 PUT https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Every field is optional; a request that sets only `receive` leaves the size alone. **The size half is what makes the quota warning honest.** `mail.mailbox_quota_warning` tells a customer their mailbox is filling up, and until this existed the only truthful advice it could give was "delete things" — the mail backend could always resize a mailbox, but nothing exposed it (#932, #662). `quota_mb` is bounded by the **plan allowance captured on the service at purchase**, so a later plan change cannot retroactively shrink what a customer was sold. Above that sits the backend package's own ceiling; both refusals answer **422** with the same customer-facing sentence, because the customer's next action is identical either way. Requires `mail.manage`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`mailboxId (path)`	`Uuid`	Sim	Mailbox ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`quota_mb`	`integer`	Não	New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
`send`	`boolean`	Não	Whether the mailbox may send.
`receive`	`boolean`	Não	Whether the mailbox may receive.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`address`	`string`	Sim	The full address.
`local`	`string`	Sim	The part before the `@`.
`quota_mb`	`integer`	Sim	This mailbox's size in MB. `0` means no cap.
`used_mb`	`integer`	Sim	How much of it is used, as the mail backend last reported it (#932). Refreshed by the hourly reconcile, so it is a recent figure rather than a live one.
`percent_used`	`integer`	Sim	How full, 0-100. Always `0` for an uncapped mailbox — a percentage of "no limit" is meaningless, not zero-ish. Read `usage_checked_at` before showing it: this is also `0` for a…
`usage_checked_at`	`string`	Não	When the backend was last asked. `null` until the first sweep sees it.
`send_enabled`	`boolean`	Sim	—
`receive_enabled`	`boolean`	Sim	—
`status`	`MailboxStatus`	Sim	One mailbox's state.
`system_managed`	`boolean`	Sim	We created this mailbox when the domain was provisioned; the customer did not ask for it. It is the address the site itself sends from, so `deleteMailbox` and `renameMailbox…
`created_at`	`string`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/mail/mailboxes/{mailboxId}