---
title: "Reset a mailbox password"
method: POST
path: "/customers/{id}/domains/{domain}/mailboxes/{address}/reset-password"
tags: ["Partners"]
---

# Reset a mailbox password

`POST /customers/{id}/domains/{domain}/mailboxes/{address}/reset-password`

## Request

- Base URL: `https://faivelo.com/api/partner`
- URL: `https://faivelo.com/api/partner/customers/{id}/domains/{domain}/mailboxes/{address}/reset-password`
- Auth: HTTP bearer

Sets a new password and returns the IMAP/SMTP settings. With no body a random password is generated and returned once; send `{ "password": "..." }` to choose it, in which case the response's `password` is `null`. No email is sent. Requires `partner:write`.

## Path parameters

- `id` string, required
- `domain` string, required
- `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, or not a partner key
- `403`: The key lacks the required scope, or provisioning is refused (partner paused, customer cap reached)
- `404`: Not found, including any customer that is not yours
- `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)