---
title: "Set a mailbox's quota"
method: PUT
path: "/customers/{id}/domains/{domain}/mailboxes/{address}/storage"
tags: ["Partners"]
---

# Set a mailbox's quota

`PUT /customers/{id}/domains/{domain}/mailboxes/{address}/storage`

## Request

- Base URL: `https://faivelo.com/api/partner`
- URL: `https://faivelo.com/api/partner/customers/{id}/domains/{domain}/mailboxes/{address}/storage`
- Auth: HTTP bearer

The disk quota the mail server enforces for this mailbox, in bytes. It must fit within the domain's cap (else the domain's plan storage), together with the explicit quotas of the domain's other mailboxes (**422** otherwise). `null` restores the plan's default per-mailbox quota. Requires `partner:write`.

## Path parameters

- `id` string, required
- `domain` string, required
- `address` string, required

## Request body

- StorageLimitRequest
  - `limitBytes` integer, nullable, required: Bytes. Null removes the cap (domain) or restores the default quota (mailbox).

## Response `200`

The mailbox with its storage

- object
  - `success` boolean
  - `data` PartnerMailbox
    - `id` string
    - `address` string
    - `displayName` string, nullable
    - `active` boolean: False while the customer is paused
    - `createdAt` string, date-time
    - `storage` StorageSummary, nullable: Bytes used and allowed. Null when the mail server could not answer.
      - `usedBytes` integer
      - `limitBytes` integer, nullable
      - `availableBytes` integer, nullable
    - `storageLimitBytes` integer, nullable: The quota you set, or null for the plan's default

## Other responses

- `401`: Missing or invalid API key, or not a partner key
- `403`: The key lacks the required scope, or provisioning is refused (partner paused, customer cap reached)
- `404`: Not found, including any customer that is not yours
- `422`: The quota does not fit
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/faivelo/apis/faivelo-api.md) · [All operations](https://skmtc.dev/faivelo/apis/faivelo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faivelo/apis/faivelo-api/revisions/a7413ddea5d1?raw)