Partners

Reset a mailbox password

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.

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

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

addressstring required

Full mailbox address, URL-encoded, e.g. hello%40smiledental.example

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.