mail

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

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

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya mail.manage; ufunguo usio nayo unakataliwa kwa 403, si 404.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`mailboxId (path)`	`Uuid`	Ndiyo	Mailbox ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`quota_mb`	`integer`	Hapana	New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
`send`	`boolean`	Hapana	Whether the mailbox may send.
`receive`	`boolean`	Hapana	Whether the mailbox may receive.

Majibu

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

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/mail/mailboxes/{mailboxId}