mail

POST `/v1/mail/mailboxes/{mailboxId}/rename`

Change a mailbox's address, keeping the mail in it.

ማረጋገጫ

የAPI ቁልፉን እንደ bearer token ይላኩ። ቁልፉ የmail.manage ፈቃድ ሊኖረው ይገባል፤ ይህ ፈቃድ የሌለው ቁልፍ በ404 ሳይሆን በ403 ውድቅ ይደረጋል።

ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (organisation id) አይወስድም። የእርስዎ ቁልፍ (key) እሱ የሚመለከተውን ድርጅት አስቀድሞ ይለያል፣ እና ምላሹም ለዚሁ የተወሰነ ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

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 ኮንሶል ውስጥ ይክፈቱ

ዝርዝሮች

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`	አዎ	—
`send_suspended_at`	`string`	አይ	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`	አይ	The counts that decided the pause, in plain words. Empty when not paused.
`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

POST /v1/mail/mailboxes/{mailboxId}/rename