mail

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

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

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 mail.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 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}

인증