Enable email forwarding for a domain

Enable email forwarding for your domain. You need to provide the domain name and its ID, which you can retrieve from the GET /api/email-forwarding endpoint. This is useful when you want emails sent to your domain to be forwarded to another address.

Domain Services Email

Context

Workflow links

Requires

domain_id from GET /api/email-forwarding

Related endpoints

GET /api/email-forwarding Get and display email forwarding settings POST /api/email-forwarding Create and manage email forwarding for your domain DELETE /api/email-forwarding Delete an email forwarding rule for a domain

Headers

Accept Example

Content-Type Example

Body

required

application/json

domain string required · Example: example.com

domainId string required · Example: 21350

force boolean · Example: true

Responses

200

data object required

data.message string required · Example: Email routing enabled for example.com (DNS sync failed - you may need to manually updat...

Human-readable message.

data.settings object required

data.settings.admin_locked boolean required · Example: false

data.settings.created string required · Example: 2026-01-29T18:04:42.471043Z

data.settings.enabled boolean required · Example: true

data.settings.id string required · Example: 996a7fea9e916e1fcf36219951f27818

data.settings.modified string required · Example: 2026-01-29T18:04:42.471043Z

data.settings.name string required · Example: example.com

data.settings.skip_wizard boolean required · Example: false

data.settings.status string required · Example: ready

data.settings.support_subaddress boolean required · Example: false

data.settings.synced boolean required · Example: true

data.settings.tag string required · Example: 996a7fea9e916e1fcf36219951f27818

data.syncResult string · nullable required · Example: null

Nullable: may be null when not applicable.

requestId string required · Example: 2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba

Unique request identifier (UUID).

success boolean required · Example: true

True for successful responses.

timestamp string required · Example: 2026-02-10T00:00:00.000Z

ISO 8601 timestamp (UTC).

POST https://cloud.hostup.se/api/email-forwarding/enable

For AI assistants

cURL

curl -X POST "https://cloud.hostup.se/api/email-forwarding/enable" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example.com",
    "domainId": "21350"
  }'

Response

{
  "success": true,
  "timestamp": "2026-02-10T00:00:00.000Z",
  "requestId": "2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba",
  "data": {
    "settings": {
      "id": "996a7fea9e916e1fcf36219951f27818",
      "tag": "996a7fea9e916e1fcf36219951f27818",
      "name": "example.com",
      "enabled": true,
      "created": "2026-01-29T18:04:42.471043Z",
      "modified": "2026-01-29T18:04:42.471043Z",
      "skip_wizard": false,
      "support_subaddress": false,
      "synced": true,
      "admin_locked": false,
      "status": "ready"
    },
    "syncResult": null,
    "message": "Email routing enabled for example.com (DNS sync failed - you may need to manually update HostBill DNS records)"
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "Human-readable message."
        },
        "settings": {
          "type": "object",
          "properties": {
            "admin_locked": {
              "type": "boolean"
            },
            "created": {
              "type": "string"
            },
            "enabled": {
              "type": "boolean"
            },
            "id": {
              "type": "string"
            },
            "modified": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "skip_wizard": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "support_subaddress": {
              "type": "boolean"
            },
            "synced": {
              "type": "boolean"
            },
            "tag": {
              "type": "string"
            }
          }
        },
        "syncResult": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "requestId": {
      "type": "string",
      "description": "Unique request identifier (UUID)."
    },
    "success": {
      "type": "boolean",
      "description": "True for successful responses."
    },
    "timestamp": {
      "type": "string",
      "description": "ISO 8601 timestamp (UTC)."
    }
  }
}

Request Body Example 1

{
  "domain": "example.com",
  "domainId": "21350"
}