PUT /v1/mail/mailboxes/{mailboxId}/recovery
Set a mailbox's recovery address.
Authentication
Send an API key as a bearer token. The key must carry the mail.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId}/recovery \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "email": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Stores an opt-in recovery address for the mailbox and e-mails it a verification link. Once verified, the mailbox's user can reset a forgotten password from the webmail sign-in page: a single-use link (30 minutes) is sent to this address — never a password. The mailbox's own address is refused (422), and so is any address while self-reset is switched off. Audited. At most 10 changes per mailbox per hour. Requires mail.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
mailboxId (path) | Uuid | Yes | Mailbox ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
email | string | Yes | The recovery address. Must not be the mailbox itself. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
address | string | Yes | The full address. |
local | string | Yes | The part before the @. |
quota_mb | integer | Yes | This mailbox's size in MB. 0 means no cap. |
used_mb | integer | Yes | 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 | Yes | 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 | No | When the backend was last asked. null until the first sweep sees it. |
send_enabled | boolean | Yes | — |
send_suspended_at | string | No | 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 | No | The counts that decided the pause, in plain words. Empty when not paused. |
receive_enabled | boolean | Yes | — |
status | MailboxStatus | Yes | One mailbox's state. |
system_managed | boolean | Yes | 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… |
credential_changed_at | object | No | When the mailbox's password was last set through us — chosen or generated in the dashboard, or changed from webmail. Never the password itself. null = not changed since this was… |
recovery_email | string | No | The opt-in recovery address a forgotten password can be reset through (empty when none). Set with setMailboxRecovery. |
recovery_verified | boolean | No | Whether the recovery address has opened its verification link. |
self_reset_available | boolean | No | Whether forgotten-password self-reset is switched on for this deployment. While it is off, setMailboxRecovery answers 422. |
migration_access_until | object | No | A move may copy mail INTO this mailbox until then (an import credential our team issued); null when there is none. Never who, never the credential. |
created_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429