---
title: "Reset mailbox password"
method: POST
path: "/mailboxes/{address}/reset-password"
tags: ["Mailboxes"]
---

# Reset mailbox password

`POST /mailboxes/{address}/reset-password`

## Request

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

Sets a new password and returns the updated credentials. With no body a secure password is generated and shown **only once**; send `{ "password": "..." }` to choose it yourself, in which case the response's `password` is `null` (you already hold it). Requires scope `mailboxes:write`.

## Path parameters

- `address` string, required

## Request body

- ResetPasswordRequest: Optional. Omit the body (or `password`) for a generated password.
  - `password` string: The password to set. 8 to 128 characters; the mail server also refuses weak ones.

## Response `200`

New credentials

- object
  - `success` boolean
  - `data` object
    - `credentials` Credentials: IMAP/SMTP connection credentials
      - `imapServer` string
      - `imapPort` integer
      - `smtpServer` string
      - `smtpPort` integer
      - `username` string
      - `password` string, nullable: The generated password, shown once. `null` when you chose the password yourself (a reset with `password`, or a partner create with one).
      - `ssl` 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)