v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB

Mail: Aliases

Create alias

Create an alias for the given mailbox. The alias address is formed from the given local part and the domain of the mailbox. Messages sent to the alias are delivered to the mailbox.

post/api/mail/v1/mailboxes/{mailboxId}/aliases

Path parameters

mailboxIdstring required

Example:AC1a2b3c4d5e6f7g

Mailbox resource ID

Request body

local_partstring required

Local part of the alias address (the part before the @). The domain is taken from the mailbox. Case-insensitive and stored lowercase; must start and end with a letter or digit; single dots, underscores and hyphens are allowed in between.

Example request

{
  "local_part": "info"
}

Response

Created response

idstring

Unique alias identifier

addressstring

Email address of the alias

is_activeboolean

Whether the alias is active and not suspended

created_atstring date-time nullable

updated_atstring date-time

Example response

{
  "id": "AA1a2b3c4d5e6f7g",
  "address": "info@example.com",
  "mailbox": {
    "id": "AC1a2b3c4d5e6f7g",
    "address": "john@example.com"
  },
  "is_active": true,
  "created_at": "2026-07-27T12:00:00Z",
  "updated_at": "2026-07-27T12:00:00Z"
}