# Create domain-level forwarder

This function creates a domain-level forwarder.

Important:

  When you disable the Receive Mail role, the system disables this function.

Endpoint: GET /Email/add_domain_forwarder
Version: 11.136.0.4
Security: BasicAuth

## Query parameters:

  - `destdomain` (string, required)
    The domain to receive forwarded mail.
    Example: "forwardtome.com"

  - `domain` (string, required)
    The domain on the cPanel account from which to forward mail.
    Example: "example.com"

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "add_domain_forwarder"

  - `module` (string)
    The name of the module called.
    Example: "Email"

  - `result` (object)

  - `result.data` (string)
    A message of success, or a reason for failure.
* A message of success that lists the updated vdomainaliases file.
* A reason for failure.
    Example: "File updated \"/etc/vdomainaliases/example.com\""

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.status` (integer)
    * 1 - Success.
* 0 - Failed. Check the errors field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.