Sign in

v51

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

Create forwarder

Create a forwarder from the given mailbox to the destination address. The destination receives a confirmation email and forwarding becomes active only after it is confirmed.

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

Path parameters

mailboxIdstring required
Example:AC1a2b3c4d5e6f7g

Mailbox resource ID

Request body

destinationstring required

Email address the messages will be forwarded to

is_keep_copy_enabledboolean

Whether to keep a copy of forwarded messages in the mailbox. Defaults to false.

Example request

{
  "destination": "jane@example.org"
}

Response

Created response

idstring

Unique forwarder identifier

destinationstring

Email address the messages are forwarded to

is_keep_copy_enabledboolean

Whether a copy of forwarded messages is kept in the mailbox

is_activeboolean

Whether the forwarder is active

is_confirmedboolean

Whether the destination address has confirmed the forwarding

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "FW1a2b3c4d5e6f7g",
  "mailbox": {
    "id": "AC1a2b3c4d5e6f7g",
    "address": "user@example.com"
  },
  "destination": "jane@example.org",
  "is_keep_copy_enabled": true,
  "is_active": true,
  "is_confirmed": true,
  "created_at": "2026-07-24T12:00:00Z",
  "updated_at": "2026-07-24T12:00:00Z"
}