mail

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

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

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`mailboxId (path)`	`Uuid`	Tak	Mailbox ID (UUIDv7).

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`quota_mb`	`integer`	Nie	New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
`send`	`boolean`	Nie	Whether the mailbox may send.
`receive`	`boolean`	Nie	Whether the mailbox may receive.

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`Uuid`	Tak	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`address`	`string`	Tak	The full address.
`local`	`string`	Tak	The part before the `@`.
`quota_mb`	`integer`	Tak	This mailbox's size in MB. `0` means no cap.
`used_mb`	`integer`	Tak	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`	Tak	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`	Nie	When the backend was last asked. `null` until the first sweep sees it.
`send_enabled`	`boolean`	Tak	—
`send_suspended_at`	`string`	Nie	When we paused this mailbox's sending because most of its recent mail was permanently refused (W43-72). null = not paused.
`send_suspended_reason`	`string`	Nie	The counts that decided the pause, in plain words. Empty when not paused.
`receive_enabled`	`boolean`	Tak	—
`status`	`MailboxStatus`	Tak	One mailbox's state.
`system_managed`	`boolean`	Tak	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`	Tak	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/mail/mailboxes/{mailboxId}