POST /v1/mail/mailboxes/{mailboxId}/rename
Change a mailbox's address, keeping the mail in it.
認証
ベアラー トークンとして API キーを送信します。キーには mail.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId}/rename \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "local": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Changes the local part — sales@example.com becomes hello@example.com — with every message already in the mailbox intact. ⚖️ Part of the owner's 2026-08-16 ruling that a domain owner must be able to "create the mailboxes easily and manage them in full". A POST to a sub-resource rather than a field on updateMailbox, deliberately. A rename moves where mail is delivered; a quota edit does not. Sharing a body would let a mistyped field change a customer's address as a side effect of resizing their mailbox, and would make the two indistinguishable in the audit log. ⛔ The engine reads the mailbox back from the backend and refuses if the address did not actually change, rather than trusting the backend's success response. It never falls back to create-then-delete: that would "work" on screen and silently destroy every stored message. 409 when the target address already exists on the domain; 422 for a mailbox that has not finished provisioning, and for the system_managed address the site sends from. Requires mail.manage.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
mailboxId (path) | Uuid | はい | Mailbox ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
local | string | はい | The new part before the @. Lower-cased and trimmed by the engine. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 · 409 · 422 · 429 · 503