Mailboxes

Set the profile picture

Uploads the mailbox's picture: PNG, JPEG or WebP, up to 500 KB, as base64 in a JSON body. Requires scope mail:write.

put/mailboxes/{address}/avatar

Request

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

Path parameters

addressstring required

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

Request body

base64string required

The image bytes, base64 (a data: prefix is tolerated). Up to 500 KB decoded.

mimeType'image/png' | 'image/jpeg' | 'image/webp' required

Response

Picture saved

successboolean

Example response

{
  "success": true,
  "data": {
    "saved": true
  }
}

Changes

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