mail

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

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

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте mail.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`mailboxId (path)`	`Uuid`	Иә	Mailbox ID (UUIDv7).

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`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.

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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`	Иә	—
`send_suspended_at`	`string`	Жоқ	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`	Жоқ	The counts that decided the pause, in plain words. Empty when not paused.
`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}