mail

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

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

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл mail.manage; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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

Параметри

Назва	Тип	Обов'язкове	Що це таке
`mailboxId (path)`	`Uuid`	Так	Mailbox ID (UUIDv7).

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`quota_mb`	`integer`	Ні	New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
`send`	`boolean`	Ні	Whether the mailbox may send.
`receive`	`boolean`	Ні	Whether the mailbox may receive.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`Uuid`	Так	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`address`	`string`	Так	The full address.
`local`	`string`	Так	The part before the `@`.
`quota_mb`	`integer`	Так	This mailbox's size in MB. `0` means no cap.
`used_mb`	`integer`	Так	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`	Так	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`	Ні	When the backend was last asked. `null` until the first sweep sees it.
`send_enabled`	`boolean`	Так	—
`receive_enabled`	`boolean`	Так	—
`status`	`MailboxStatus`	Так	One mailbox's state.
`system_managed`	`boolean`	Так	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`	Так	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/mail/mailboxes/{mailboxId}