Create email forwarder

Read full description Hide full description

Create an email forwarder or discard/noreply address inside a shared-hosting account. Use this route only when the source domain is attached to this hosting account; verify that with GET /api/v2/shared-hosting/{accountId}/domains before writing. Send the source address as localPart plus domain; if the caller gives [email protected], split it into localPart: "info" and domain: "example.com". This route manages the hosting account's mail-forwarder bindings and does not enable or replace domain-level email routing. If the customer does not have shared hosting, or this domain is not attached to the hosting account, use POST /api/v2/domains/{id}/email-forwarding for source-address rules or PUT /api/v2/domains/{id}/email-forwarding for catch-all forwarding. There is no /api/v2/shared-hosting/{accountId}/catch-all route. For normal forwarding send action: "forward" or omit action, plus one to twenty destination email addresses in destinations. A singular destination string is accepted only as a compatibility alias for one recipient; prefer destinations. For a noreply/drop mailbox send action: "discard" and omit destinations; do not send cPanel-specific values such as :blackhole: or /dev/null.

Web Hosting Email

Authentication

Required API scopes: write:hostingconsole:services

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

Context

Related endpoints

GET /api/v2/shared-hosting/{accountId}/email-forwarders List email forwarders DELETE /api/v2/shared-hosting/{accountId}/email-forwarders/{address} Delete email forwarder destinations GET /api/v2/shared-hosting/{accountId}/domains List hosting domains

Path Parameters

accountId string required Example: acct_01hxa3b4c5d6e7f8g9h0j1k2m3

Public shared-hosting account ID. Get it from GET /api/v2/shared-hosting `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

localPart string required · Example: info

Address part before `@`. For `[email protected]`, send `info`.

domain string required · Example: example.com

Hosted domain attached to this shared-hosting account. Get it from `GET /api/v2/shared-hosting/{accountId}/domains`.

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

Destination mailbox addresses for `action: "forward"`. Omit for `action: "discard"`.

destination string · Example: [email protected]

Compatibility alias for a single destination address. Prefer `destinations: ["[email protected]"]`; do not send both fields.

action string · enum · Example: forward

Use `forward` to send mail to destinations. Use `discard` for noreply/drop behavior; the API translates this to the control-panel discard mode.

forward

discard

Responses

201 Email forwarder created.

id string required · Example: efwd_01hxa3b4c5d6e7f8g9h0j1k2m3

email string required

domain string required

localPart string required

action string · enum required

forward

discard

destinations array<string> required

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

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/shared-hosting/{accountId}/email-forwarders

For AI assistants

View as Markdown

cURL

curl -X POST "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3/email-forwarders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "localPart": "info",
    "domain": "example.com",
    "action": "forward",
    "destinations": [
      "[email protected]"
    ]
  }'

Response

{
  "id": "efwd_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "email": "[email protected]",
  "domain": "example.com",
  "localPart": "info",
  "action": "forward",
  "destinations": [
    "[email protected]"
  ]
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    },
    "localPart": {
      "type": "string"
    },
    "action": {
      "type": "string",
      "enum": [
        "forward",
        "discard"
      ]
    },
    "destinations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Request Body Forward to one recipient

{
  "localPart": "info",
  "domain": "example.com",
  "action": "forward",
  "destinations": [
    "[email protected]"
  ]
}