---
title: "Create default email address"
method: GET
path: "/Email/set_default_address"
tags: ["Email", "Email Accounts"]
---

# Create default email address

`GET /Email/set_default_address`

This function configures a default (catchall) email address.

**Important**:

  When you disable the [Mail Receive role](https://go.cpanel.net/serverroles), the system **disables** this function.

## Query parameters

- `fwdopt` 'fwd' | 'fail' | 'blackhole' | 'pipe', required
- `domain` string, domain
- `failmsgs` string
- `fwdemail` string, email
- `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[] — An array of hashes of forwarder information. This array of hashes includes the domain and dest returns.
      - `dest` string — The destination to which the system sends unroutable 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.
      - `domain` string — The domain. A valid domain on the 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)