Mailboxes

Reset mailbox password

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.

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

Path parameters

addressstring required

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

Request body

passwordstring

The password to set. 8 to 128 characters; the mail server also refuses weak ones.

Response

New credentials

successboolean

Example response

{
  "success": true,
  "data": {
    "credentials": {
      "imapServer": "mail.faivelo.com",
      "imapPort": 993,
      "smtpServer": "mail.faivelo.com",
      "smtpPort": 465,
      "username": "jane@yourdomain.com",
      "password": "generated-password-here",
      "ssl": true
    }
  }
}

Changes

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