POST /v1/mail/mailboxes/{mailboxId}/rename
Change a mailbox's address, keeping the mail in it.
Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu mail.manage; ključ bez nje se odbija s kodom 403, a ne 404.
Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
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> }'Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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.
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
mailboxId (path) | Uuid | Da | Mailbox ID (UUIDv7). |
Tijelo zahtjeva
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
local | string | Da | The new part before the @. Lower-cased and trimmed by the engine. |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
address | string | Da | The full address. |
local | string | Da | The part before the @. |
quota_mb | integer | Da | This mailbox's size in MB. 0 means no cap. |
used_mb | integer | Da | 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 | Da | 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 | Ne | When the backend was last asked. null until the first sweep sees it. |
send_enabled | boolean | Da | — |
send_suspended_at | string | Ne | 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 | Ne | The counts that decided the pause, in plain words. Empty when not paused. |
receive_enabled | boolean | Da | — |
status | MailboxStatus | Da | One mailbox's state. |
system_managed | boolean | Da | 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 | Da | — |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 404 · 409 · 422 · 429 · 503