Mailboxes

Update a mailbox

Toggle active status and/or change the display name. At least one field is required. Requires scope mailboxes:write.

patch/mailboxes/{address}

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/mailboxes/{address}
  • Auth: HTTP bearer

Path parameters

addressstring required

Full mailbox address, e.g. user@yourdomain.com

Request body

activeboolean

Enable or disable the mailbox

displayNamestring

The From name recipients see on mail from this mailbox; "" clears it (mail then shows the domain default, else the bare address)

Response

Updated mailbox

successboolean

Example response

{
  "success": true,
  "data": {
    "localPart": "jane",
    "fullAddress": "jane@yourdomain.com",
    "displayName": "Jane Doe",
    "active": true,
    "storage": {
      "usedBytes": 3221225472,
      "limitBytes": 53687091200,
      "availableBytes": 50465865728
    }
  }
}

Changes

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