mail

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

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

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na mail.manage; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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

Mga Parameter

Pangalan	Uri	Kailangan	Ano ito
`mailboxId (path)`	`Uuid`	Oo	Mailbox ID (UUIDv7).

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`quota_mb`	`integer`	Hindi	New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
`send`	`boolean`	Hindi	Whether the mailbox may send.
`receive`	`boolean`	Hindi	Whether the mailbox may receive.

Tugon

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

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/mail/mailboxes/{mailboxId}