---
title: "Set the profile picture"
method: PUT
path: "/mailboxes/{address}/avatar"
tags: ["Mailboxes"]
---

# Set the profile picture

`PUT /mailboxes/{address}/avatar`

## Request

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

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

## Path parameters

- `address` string, required

## Request body

- AvatarUpload
  - `base64` string, required: The image bytes, base64 (a `data:` prefix is tolerated). Up to 500 KB decoded.
  - `mimeType` 'image/png' | 'image/jpeg' | 'image/webp', required

## Response `200`

Picture saved

- object
  - `success` boolean
  - `data` object
    - `saved` boolean

## Other responses

- `401`: Missing or invalid API key
- `402`: The account's plan does not include the API (`plan_required`)
- `403`: The key lacks the required scope
- `404`: Resource not found
- `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)