← Back to API List

email - addcustomdomain

Adds a custom domain to be used to send on behalf.

API Call Information

area: email

action: addcustomdomain

API Arguments

Argument	Data Type	Required	Description
domain	string	Yes	Domain name to be be sent on be half. Examples: mydomain.com sub.domain.com
domainid	integer	Yes	Domain ID found from the domains section to tie the custom domain to. This will be the return-path/tracking domain as well

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=addcustomdomain&domain=test.com&domainid=111

API Response

XML Response

<response>
  <customfromdomain>
    <id>7</id>
    <domain>test.com</domain>
  </customfromdomain>
</response>

JSON Response

{
    "customfromdomain": {
        "id": "7",
        "domain": "test.com"
    }
}