mail

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

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

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran mail.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`mailboxId (path)`	`Uuid`	Ya	Mailbox ID (UUIDv7).

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`quota_mb`	`integer`	Tidak	New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
`send`	`boolean`	Tidak	Whether the mailbox may send.
`receive`	`boolean`	Tidak	Whether the mailbox may receive.

Respons

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

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/mail/mailboxes/{mailboxId}