mail

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

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

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie mail.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X PUT https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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`.

Parameters

Naam	Type	Verplicht	Wat dit is
`mailboxId (path)`	`Uuid`	Ja	Mailbox ID (UUIDv7).

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`quota_mb`	`integer`	Nee	New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
`send`	`boolean`	Nee	Whether the mailbox may send.
`receive`	`boolean`	Nee	Whether the mailbox may receive.

Reactie

Naam	Type	Verplicht	Wat dit is
`id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`address`	`string`	Ja	The full address.
`local`	`string`	Ja	The part before the `@`.
`quota_mb`	`integer`	Ja	This mailbox's size in MB. `0` means no cap.
`used_mb`	`integer`	Ja	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`	Ja	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`	Nee	When the backend was last asked. `null` until the first sweep sees it.
`send_enabled`	`boolean`	Ja	—
`receive_enabled`	`boolean`	Ja	—
`status`	`MailboxStatus`	Ja	One mailbox's state.
`system_managed`	`boolean`	Ja	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`	Ja	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/mail/mailboxes/{mailboxId}