Sign in

v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB
Mail: Mailboxes

Create mailbox

Create a mailbox under the given mail order. The full email address is composed from the given local part and the domain of the order.

post/api/mail/v1/orders/{orderId}/mailboxes

Path parameters

orderIdstring required
Example:OR1a2b3c4d5e6f7g

Order resource ID

Request body

local_partstring required

Local part of the mailbox address (the part before the @). The domain is taken from the order. Must start and end with a letter or digit; single dots, underscores and hyphens are allowed in between.

passwordstring password required

Mailbox password. Minimum 8 characters with uppercase, lowercase, number and special character.

Example request

{
  "local_part": "john.doe",
  "password": "SecurePassword123!"
}

Response

Created response

idstring

Mailbox resource ID

addressstring

Email address of the mailbox

status'active' | 'suspended'

Mailbox status

status_reasonstring nullable

Reason the mailbox was suspended

is_catchallboolean

Whether the mailbox is the catch-all destination for its domain

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "AC1a2b3c4d5e6f7g",
  "address": "info@example.com",
  "status": "active",
  "status_reason": "abuse",
  "protocols": {
    "is_imap_enabled": true,
    "is_pop3_enabled": true,
    "is_smtp_in_enabled": true,
    "is_smtp_out_enabled": true
  },
  "counts": {
    "forwarders": 2,
    "aliases": 1
  },
  "usage": {
    "storage_used": 512000,
    "storage_quota": 10485760,
    "messages_used": 1240,
    "messages_quota": 50000,
    "synced_at": "2026-07-22T08:12:00Z"
  },
  "created_at": "2025-03-01T10:00:00Z",
  "updated_at": "2026-07-20T14:30:00Z"
}