Create domain email forwarding rule

Create one or more domain-level email forwarding rules. Get {id} from GET /api/v2/domains data[].id. Use this route when the domain is not managed through a shared-hosting account. If the domain appears in GET /api/v2/shared-hosting/{accountId}/domains, prefer `POST…

Read full description Hide full description

Create one or more domain-level email forwarding rules. Get {id} from GET /api/v2/domains data[].id. Use this route when the domain is not managed through a shared-hosting account. If the domain appears in GET /api/v2/shared-hosting/{accountId}/domains, prefer POST /api/v2/shared-hosting/{accountId}/email-forwarders instead because enabling domain-level routing can replace the mail routing used by hosting mailboxes. source must be a full email address on this domain. destinations must be unique valid email addresses; one request may contain at most 10 destinations, and the domain may have at most 200 forwarding rules total. The route auto-enables email routing before creating rules when the domain is eligible.

Domains & DNS Email Forwarding

Authentication

Required API scopes: write:emailwrite:domains

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

Path Parameters

id string required Example: dom_01hxa3b4c5d6e7f8g9h0j1k2m3

Public domain ID from `GET /api/v2/domains` `data[].id`. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Accept Example
Content-Type Example

Body

required
application/json
source string required · Example: [email protected]

Full email address on the domain being managed.

destinations array required · Example: ["[email protected]"]

Responses

201 Email forwarding rules created and state refreshed.
enabled boolean · Example: true
integrationStatus string · enum · Example: enabled
enabled
disabled
unavailable
reason stringnull · Example: null
maxRules integer · Example: 200
ruleCount integer · Example: 1
rules array<object>
rules[].id string required · Example: ef_01hxa3b4c5d6e7f8g9h0j1k2m3
rules[].email string required · Example: [email protected]
rules[].destination string required · Example: [email protected]
rules[].isEnabled boolean required · Example: true
rules[].name stringnull required · Example: null
rules[].priority integer required · Example: 0
destinations array<object>
destinations[].id string required · Example: efd_01hxa3b4c5d6e7f8g9h0j1k2m3
destinations[].email string required · Example: [email protected]
destinations[].verificationStatus string · enum required · Example: verified
verified
pending
unverified
destinations[].createdAt stringnull required · Example: 2026-04-27T12:00:00.000Z
destinations[].verifiedAt stringnull required · Example: 2026-04-27T12:05:00.000Z
catchAll object | null · Example: {"action":"disabled","destination":null}
catchAll.action string · enum required · Example: disabled
forward
drop
disabled
catchAll.destination stringnull required · Example: null
existingMxRecords array<object>
existingMxRecords[].type string · enum required · Example: MX
MX
existingMxRecords[].value string required · Example: mail.example.com
existingMxRecords[].priority integernull required · Example: 10
actions object
actions.canCreateNewRule object required
actions.canCreateNewRule.allowed boolean required · Example: true
actions.canCreateNewRule.reason stringnull required · Example: null
actions.canCreateNewRule.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canSetCatchAll object required
actions.canSetCatchAll.allowed boolean required · Example: true
actions.canSetCatchAll.reason stringnull required · Example: null
actions.canSetCatchAll.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

createOutcome object
createOutcome.createdRuleCount integer required · Example: 1
createOutcome.createdRules array<object> required
createOutcome.createdRules[].id string required · Example: ef_01hxa3b4c5d6e7f8g9h0j1k2m3
createOutcome.createdRules[].email string required · Example: [email protected]
createOutcome.createdRules[].destination string required · Example: [email protected]
createOutcome.createdRules[].isEnabled boolean required · Example: true
createOutcome.createdRules[].name stringnull required · Example: null
createOutcome.createdRules[].priority integer required · Example: 0
400 Invalid request. The response body is an RFC 7807 Problem Details document.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
401 Unauthorized. Authentication is required.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
403 Forbidden. The caller lacks a required scope or does not own the resource.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
404 Not found. The resource does not exist or is not owned by the caller.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
409 Conflict. See the Problem Details `code` for the route-specific blocker and recovery fields.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
429 Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
500 Internal error. Retry later or contact support if the issue persists.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
POST https://cloud.hostup.se/api/v2/domains/{id}/email-forwarding
For AI assistants
View as Markdown
cURL 
curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/email-forwarding" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "[email protected]",
    "destinations": [
      "[email protected]"
    ]
  }'
Response 
{
  "enabled": true,
  "integrationStatus": "enabled",
  "reason": null,
  "maxRules": 200,
  "ruleCount": 1,
  "rules": [
    {
      "id": "ef_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "email": "[email protected]",
      "destination": "[email protected]",
      "isEnabled": true,
      "name": "hello",
      "priority": 0
    }
  ],
  "destinations": [
    {
      "id": "efd_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "email": "[email protected]",
      "verificationStatus": "verified",
      "createdAt": "2026-04-27T12:00:00.000Z",
      "verifiedAt": "2026-04-27T12:05:00.000Z"
    }
  ],
  "catchAll": {
    "action": "disabled",
    "destination": null
  },
  "existingMxRecords": [],
  "actions": {
    "canCreateNewRule": {
      "allowed": true,
      "reason": null
    },
    "canSetCatchAll": {
      "allowed": true,
      "reason": null
    }
  },
  "createOutcome": {
    "createdRuleCount": 1,
    "createdRules": [
      {
        "id": "ef_01hxa3b4c5d6e7f8g9h0j1k2m3",
        "email": "[email protected]",
        "destination": "[email protected]",
        "isEnabled": true,
        "name": "hello",
        "priority": 0
      }
    ]
  }
}
Request Body Forward one address 
{
  "source": "[email protected]",
  "destinations": [
    "[email protected]"
  ]
}