Sign in

v1

latestOpenAPI 3.1.12026-07-17111158225.7 KB
domain emailforwards

Create an email forward

Creates a new email forward for the domain.

post/{account}/domains/{domain}/email_forwards

Path parameters

accountinteger required

The account id

domainstring required

The domain name or id

Request body

alias_namestring

The receiving email recipient, the name part only without the domain. The domain is automatically appended.

destination_emailstring email

The email recipient the messages are delivered to.

Example request

{
  "alias_name": "john.doe",
  "destination_email": "john@example.com"
}

Response

Successfully created new email forward.

Example response

{
  "data": {
    "id": 1,
    "domain_id": 2,
    "alias_email": "john.doe@a-domain.com",
    "destination_email": "john@example.com",
    "created_at": "2016-02-04T14:26:50Z",
    "updated_at": "2016-02-04T14:26:50Z",
    "active": true
  }
}