Partners

Create a mailbox

Create an inbox. The response carries the IMAP/SMTP settings and, unless you chose one, the generated password exactly once; show them to the end customer or reset later. With a password of your own the response's password is null. Requires partner:write.

post/customers/{id}/domains/{domain}/mailboxes

Request

Base URL: https://faivelo.com/api/partner
URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/mailboxes
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

Request body

localPartstring required

The part before the @. 1 to 64 chars, alphanumeric plus ._%+-

displayNamestring

passwordstring

Optional. The password to set, 8 to 128 characters (the mail server also refuses weak ones); omit for a generated one, returned once.

Example request

{
  "localPart": "hello",
  "displayName": "Smile Dental"
}

Response

The mailbox with its one-time credentials

successboolean

Example response

{
  "success": true,
  "data": {
    "localPart": "jane",
    "fullAddress": "jane@yourdomain.com",
    "active": true,
    "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.