PUT /v1/mail/mailboxes/{mailboxId}
Change a mailbox's size, or its send/receive switches.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation mail.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X PUT https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
Every field is optional; a request that sets only receive leaves the size alone. The size half is what makes the quota warning honest. mail.mailbox_quota_warning tells a customer their mailbox is filling up, and until this existed the only truthful advice it could give was "delete things" — the mail backend could always resize a mailbox, but nothing exposed it (#932, #662). quota_mb is bounded by the plan allowance captured on the service at purchase, so a later plan change cannot retroactively shrink what a customer was sold. Above that sits the backend package's own ceiling; both refusals answer 422 with the same customer-facing sentence, because the customer's next action is identical either way. Requires mail.manage.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
mailboxId (path) | Uuid | Oui | Mailbox ID (UUIDv7). |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
quota_mb | integer | Non | New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling. |
send | boolean | Non | Whether the mailbox may send. |
receive | boolean | Non | Whether the mailbox may receive. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
address | string | Oui | The full address. |
local | string | Oui | The part before the @. |
quota_mb | integer | Oui | This mailbox's size in MB. 0 means no cap. |
used_mb | integer | Oui | 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 | Oui | 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 | Non | When the backend was last asked. null until the first sweep sees it. |
send_enabled | boolean | Oui | — |
receive_enabled | boolean | Oui | — |
status | MailboxStatus | Oui | One mailbox's state. |
system_managed | boolean | Oui | 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 | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429 · 503