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

# Create a mailbox

`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

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`.

## Path parameters

- `id` string, required
- `domain` string, required

## Request body

- object
  - `localPart` string, required: The part before the @. 1 to 64 chars, alphanumeric plus `._%+-`
  - `displayName` string
  - `password` string: Optional. The password to set, 8 to 128 characters (the mail server also refuses weak ones); omit for a generated one, returned once.

## Response `201`

The mailbox with its one-time credentials

- object
  - `success` boolean
  - `data` MailboxWithCredentials: Newly created mailbox with one-time credentials
    - `id` string
    - `localPart` string
    - `fullAddress` string
    - `displayName` string, nullable
    - `active` boolean
    - `createdAt` string, date-time
    - `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

- `400`: Invalid input
- `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)