Create email account

POST /api/v2/shared-hosting/{accountId}/email-accounts

Create an email account on a cPanel-backed shared-hosting account.

Get accountId from GET /api/v2/shared-hosting data[].id.

Send localPart and domain; do not send email, username, address, or a full email address.

If the caller gives [email protected], split it into localPart: "hello" and domain: "example.com".

Internationalized domains are accepted in customer-facing Unicode form (for example pyramidmåleri.se) or punycode form; the API canonicalizes them before the cPanel operation and returns the readable Unicode form.

The domain must belong to the hosting account.

Passwords must be 8-128 characters, include uppercase, lowercase, and a number, and be strong enough to pass guessability checks; weak passwords return password_too_weak.

Omit quotaMb to use the HostUp default of 32768 MB (32 GB).

If this returns account_not_eligible_cpanel, contact support and we will migrate the existing account to cPanel at no extra charge; no new hosting plan is needed.

Web Hosting Email

Authentication

Required API scopes: write:hostingconsole:services

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Related endpoints

GET /api/v2/shared-hosting/{accountId}/email-accounts List email accounts DELETE /api/v2/shared-hosting/{accountId}/email-accounts/{address} Delete email account PUT /api/v2/shared-hosting/{accountId}/email-accounts/{address}/quota Replace email account quota

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

Authorization Bearer <token>

Accept application/json

Content-Type application/json

Body

required

application/json

localPart string required · Example: hello

Local part of the email address only, for example hello in [email protected]. Do not send username, address, or include @domain.

domain string required · Example: pyramidmåleri.se

Domain hosted on this shared-hosting account. Unicode IDN and punycode spellings are both accepted.

password string required · Example: YOUR_EMAIL_ACCOUNT_PASSWORD

Email account password. Must include uppercase, lowercase, and a number, and must be strong enough to avoid password_too_weak.

quotaMb number · min: 0 · max: 1048576 · Example: 1024

Email account storage quota in megabytes. Omit for the default 32768 MB.

Responses

201 Created email account. 4 fields

id string required · Example: mail_01hxa3b4c5d6e7f8g9h0j1k2m3

email string required · Example: [email protected]

domain string required · Example: example.com

quota object required

quota.usedGb number · nullable required · Example: 0

Nullable: may be null when not applicable.

quota.limitGb number · nullable required · Example: 1

Nullable: may be null when not applicable.

quota.usagePercent number · nullable required · Example: 0

Nullable: may be null when not applicable.

quota.exceeded boolean required · Example: false

400 The supplied password is too weak or the request is invalid. 10 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

401 Unauthorized. Authentication is required. 10 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

403 Forbidden. The caller lacks a required scope or does not own the resource. 10 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

404 Not found. The resource does not exist or is not owned by the caller. 10 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

409 The mailbox already exists on the hosting account, or the hosting account uses HostUp's previous hosting platform so email account creation is not available through this API. 10 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. 10 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

500 Internal error. Retry later or contact support if the issue persists. 10 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

502 Upstream failure. A dependent provider request failed; the Problem Details code is upstream_failed. Retry later or contact support if the issue persists. 10 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

POST https://cloud.hostup.se/api/v2/shared-hosting/{accountId}/email-accounts

For AI assistants

View as Markdown

cURL

curl -X POST "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3/email-accounts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "localPart": "hello",
    "domain": "example.com",
    "password": "YOUR_EMAIL_ACCOUNT_PASSWORD",
    "quotaMb": 1024
  }'

Response

{
  "id": "mail_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "email": "[email protected]",
  "domain": "example.com",
  "quota": {
    "usedGb": 0,
    "limitGb": 1,
    "usagePercent": 0,
    "exceeded": false
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    },
    "quota": {
      "type": "object",
      "properties": {
        "usedGb": {
          "type": "number",
          "nullable": true
        },
        "limitGb": {
          "type": "number",
          "nullable": true
        },
        "usagePercent": {
          "type": "number",
          "nullable": true
        },
        "exceeded": {
          "type": "boolean"
        }
      }
    }
  }
}

Request Body Create email account

{
  "localPart": "hello",
  "domain": "example.com",
  "password": "YOUR_EMAIL_ACCOUNT_PASSWORD",
  "quotaMb": 1024
}