## PUT /api/v2/domains/{id}/email-forwarding

**Update domain email catch-all**

Configure the domain-level catch-all behavior for unmatched addresses. Get `{id}` from `GET /api/v2/domains` `data[].id`. This is part of domain email forwarding, not shared-hosting forwarders. If the domain is attached to a shared-hosting account and you want hosting mailboxes/forwarders to keep handling mail, manage forwarding through `/api/v2/shared-hosting/{accountId}/email-forwarders` instead. Send `action: "forward"` with `forwardTo` to forward all unmatched mail, `action: "drop"` to silently discard unmatched mail, or `action: "fail"` to disable/fail unmatched delivery. The response is the refreshed catch-all object, not the full forwarding state.

### Related Endpoints

- `GET /api/v2/domains/{id}/email-forwarding`: Get domain email forwarding
- `PATCH /api/v2/domains/{id}/email-forwarding`: Toggle domain email forwarding
- `POST /api/v2/domains/{id}/email-forwarding`: Create domain email forwarding rule

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scopes: `write:email`, `write:domains`
- `Content-Type`: application/json

### Parameters

- `id` (path, string, required): 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. Example: `dom_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Body

- `action` (string, required): `fail` is the v2 public label for disabling the catch-all route. Example: `forward`
  Allowed values: forward, drop, fail
- `forwardTo` (string, optional): Required only when `action` is `forward`. Example: `owner@example.net`

### Request Examples

#### Forward all unmatched mail

```bash
curl -X PUT "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 '{
    "action": "forward",
    "forwardTo": "owner@example.net"
  }'
```

```json
{
  "action": "forward",
  "forwardTo": "owner@example.net"
}
```

#### Silently drop unmatched mail

```bash
curl -X PUT "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 '{
    "action": "drop"
  }'
```

```json
{
  "action": "drop"
}
```

#### Disable catch-all delivery

```bash
curl -X PUT "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 '{
    "action": "fail"
  }'
```

```json
{
  "action": "fail"
}
```

### Response Schema

- `action` (string, required) Example: `forward`
  Allowed values: forward, drop, disabled
- `destination` (string,null, required) Example: `owner@example.net`

### Responses

#### 200 - Refreshed catch-all state.
```json
{
  "action": "forward",
  "destination": "owner@example.net"
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 409 - Conflict. See the Problem Details `code` for the route-specific blocker and recovery fields.
```json
{
  "status": 409,
  "instance": "/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/email-forwarding",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "type": "https://developer.hostup.se/errors/mx_record_blocked_email_forwarding",
  "title": "Email forwarding blocked by MX records",
  "detail": "Email forwarding cannot be enabled while the domain has custom MX records.",
  "code": "mx_record_blocked_email_forwarding",
  "actions": {
    "canCreateNewRule": {
      "allowed": false,
      "reason": "Email forwarding cannot be enabled while the domain has custom MX records."
    }
  }
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```