Domain Management
Domain Contacts
- Domains Contacts
Name Server Groups
- Name Server Groups
DNZ Zones and Records
Email and Web Forwarding
- Email Forwarding
- Web Forwarding
SSL Certificates
- Private Keys
- SSL Certificates

API Access

Build custom apps using our JSON API

Configure API

Email Forwarding - Domain Name API

Email forwarding allows a domain to be used to simply forward emails to another address without needing to configure an inbound email server/service

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/dom/domain/{domain_uuid}/email-forward

Gets all active email forwards for the specific domain

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- domain_uuid
- String
- True
The UUID of the domain to query the email forward for

Response Details

200 Response

{
    "result" : [
        {
            "created_on" : "2023-03-23",
            "destination_address" : "example@example.com",
            "mailbox_name" : "postmaster",
            "updated_on" : "2023-03-23",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/dom/domain/{domain_uuid}/email-forward/{uuid}

Gets a specific email forward for the specified domain

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the email forward to query
- domain_uuid
- String
- True
The UUID of the domain to query the email forward for

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-03-23",
        "destination_address" : "example@example.com",
        "mailbox_name" : "postmaster",
        "updated_on" : "2023-03-23",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

POST/dom/domain/{domain_uuid}/email-forward

Creates an email forward for the specific domain

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- domain_uuid
- String
- True
The UUID of the domain to create the email forward for

POST body

Name
Type
Required

- destination_address
- String
- True
The destination email address to forward the incoming message to
- mailbox_name
- String
- True
The name of the target email address to catch and forward for

JSON all-fields example:

{
    "destination_address" : "example@example.com",
    "mailbox_name" : "postmaster"
}

Response Details

201 Response

{
    "result" : {
        "created_on" : "2023-03-23",
        "destination_address" : "example@example.com",
        "mailbox_name" : "postmaster",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

409 Response

{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}

PUT/dom/domain/{domain_uuid}/email-forward/{uuid}

Updates the specified email forward for the specific domain

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- domain_uuid
- String
- True
The UUID of the domain to update the email forward for
- uuid
- String
- True
The UUID of the email forward to be updated

PUT body

Name
Type
Required

- destination_address
- String
- True
The destination email address to forward the incoming message to
- mailbox_name
- String
- True
The name of the target email address to catch and forward for

JSON all-fields example:

{
    "destination_address" : "example@example.com",
    "mailbox_name" : "postmaster"
}

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-03-23",
        "destination_address" : "example@example.com",
        "mailbox_name" : "postmaster",
        "updated_on" : "2023-03-23",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

409 Response

{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}

DELETE/dom/domain/{domain_uuid}/email-forward/{uuid}

Deletes the specified email forward for the specific domain
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- domain_uuid
  
  String
  
  True
  
  The UUID of the domain to delete the email forward for
- uuid
  
  String
  
  True
  
  The UUID of the email forward to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```