Partners

Cap a domain's storage

Caps what the domain's mailboxes may use together, in bytes, below the storage of the domain's plan. A cap must cover the explicit quotas already set on the domain's mailboxes (422 otherwise). Mailboxes on the plan's default quota are re-clipped to the cap on the mail server. null removes the cap. Requires partner:write.

put/customers/{id}/domains/{domain}/storage

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/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

Request body

limitBytesinteger nullable required

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

Example request

{
  "limitBytes": 53687091200
}

Response

The domain with its storage

successboolean

Example response

{
  "success": true,
  "data": {
    "domain": "smiledental.example",
    "brandName": "Smile Dental",
    "dnsRecords": [
      {
        "type": "MX",
        "name": "smiledental.example",
        "value": "10 mx.faivelo.com"
      }
    ],
    "storage": {
      "usedBytes": 3221225472,
      "limitBytes": 53687091200,
      "availableBytes": 50465865728
    }
  }
}

Changes

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