---
title: "Create email account forwarder"
method: GET
path: "/Email/add_forwarder"
tags: ["Email", "Email Forwarding"]
---

# Create email account forwarder

`GET /Email/add_forwarder`

This function creates an email forwarder.

**Important:**

  When you disable the MailReceive role, the system disables this function.
  For more information, read our [How to Use Server Profiles](https://go.cpanel.net/howtouseserverprofiles)
  documentation.

## Query parameters

- `domain` string, required
- `email` string, required
- `fwdopt` string, required
- `failmsgs` string
- `fwdemail` string
- `fwdsystem` string
- `pipefwd` string

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[]
      - `domain` string — The domain. A valid domain on the account.
      - `email` string — The email address. An email address on the account.
      - `forward` string — The method that the system will use to handle the address's mail. - An email address The system forwards mail to this address. - :fail: The system bounces mail back to the sender and sends a failure message. - :blackhole: The system deletes mail without a failure message. - The path to an application The system pipes mail to this application. - A username The system forwards mail to this system account.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 0 | 1 — - 1 - Success - 0 - Failed: Check the errors field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)