Sign in

v51

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

Create catch-all

Create a catch-all that routes all messages sent to unknown addresses of the domain to the given mailbox. The mailbox address receives a confirmation email and the catch-all becomes active only after it is confirmed. A domain can have only one catch-all.

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

Path parameters

mailboxIdstring required
Example:AC1a2b3c4d5e6f7g

Mailbox resource ID

Response

Created response

idstring

Unique catch-all identifier

domainstring

Domain whose unrouted messages are caught

is_activeboolean

Whether the catch-all is active

is_confirmedboolean

Whether the mailbox address has confirmed the catch-all

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "CA1a2b3c4d5e6f7g",
  "mailbox": {
    "id": "AC1a2b3c4d5e6f7g",
    "address": "user@example.com"
  },
  "domain": "example.com",
  "is_active": true,
  "is_confirmed": true,
  "created_at": "2026-07-27T12:00:00Z",
  "updated_at": "2026-07-27T12:00:00Z"
}