POST /v1/mail/mailboxes/{mailboxId}/rename
Change a mailbox's address, keeping the mail in it.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) mail.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
mailboxId (path) | Uuid | Igen | Mailbox ID (UUIDv7). |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
local | string | Igen | The new part before the @. Lower-cased and trimmed by the engine. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
address | string | Igen | The full address. |
local | string | Igen | The part before the @. |
quota_mb | integer | Igen | This mailbox's size in MB. 0 means no cap. |
used_mb | integer | Igen | 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 | Igen | 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 | Nem | When the backend was last asked. null until the first sweep sees it. |
send_enabled | boolean | Igen | — |
send_suspended_at | string | Nem | 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 | Nem | The counts that decided the pause, in plain words. Empty when not paused. |
receive_enabled | boolean | Igen | — |
status | MailboxStatus | Igen | One mailbox's state. |
system_managed | boolean | Igen | 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 | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 409 · 422 · 429 · 503