Partners

Set a mailbox's quota

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.

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

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

addressstring required

Full mailbox address, URL-encoded, e.g. hello%40smiledental.example

Request body

limitBytesinteger nullable required

Bytes. Null removes the cap (domain) or restores the default quota (mailbox).

Example request

{
  "limitBytes": 53687091200
}

Response

The mailbox with its storage

successboolean

Example response

{
  "success": true,
  "data": {
    "address": "hello@smiledental.example",
    "storage": {
      "usedBytes": 3221225472,
      "limitBytes": 53687091200,
      "availableBytes": 50465865728
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.