---
title: "Setup email forward"
method: POST
path: "/v1/domains/{domain_id}/forward"
tags: ["Domains"]
---

# Setup email forward

`POST /v1/domains/{domain_id}/forward`

## Request

- Base URL: `https://api.winnr.app`
- URL: `https://api.winnr.app/v1/domains/{domain_id}/forward`
- Auth: HTTP bearer

Configure email forwarding for the domain. A copy of every email
received by any mailbox on the domain is delivered to the forward address.

## Path parameters

- `domain_id` string, required

## Request body

- ForwardRequest
  - `address` string, email, required: The email address to forward all domain emails to

## Response `200`

Forward configured

- object
  - `meta` Meta
    - `request_id` string
    - `timestamp` string, date-time
  - `data` object
    - `domain` string
    - `forward_address` string
    - `queued` boolean
    - `message` string

## Other responses

- `401`: Authentication required or token invalid
- `404`: Resource not found

---

[API](https://skmtc.dev/winnr/apis/winnr-api.md) · [All operations](https://skmtc.dev/winnr/apis/winnr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/winnr/apis/winnr-api/revisions/a4f960beb1eb?raw)