---
title: "Update email user"
method: PATCH
path: "/v1/email-users/{user_id}"
tags: ["Email Users"]
---

# Update email user

`PATCH /v1/email-users/{user_id}`

## Request

- Base URL: `https://api.winnr.app`
- URL: `https://api.winnr.app/v1/email-users/{user_id}`
- Auth: HTTP bearer

Update email user settings.

## Path parameters

- `user_id` string, required

## Request body

- UpdateEmailUserRequest
  - `name` string
  - `password` string

## Response `200`

Updated email user

- EmailUserResponse
  - `data` EmailUser
    - `id` string: Firestore document ID for the email user.
    - `username` string: Local part of the email address (before the `@`).
    - `domain` string: Domain string (after the `@`).
    - `full_address` string, email: Full email address (`{username}@{domain}`). Use this when sending mail.
    - `name` string, nullable: Display name (used in the From header).
    - `status` 'active' | 'paused' | 'disabled': Mailbox lifecycle state. - `active` — mailbox is provisioned and warming/sending normally. - `paused` — warming temporarily paused; mailbox still exists. - `disabled` — mailbox is disabled (e.g. plan past-due, account hold).
    - `type` string, nullable: Mailbox type (e.g. `cold_email`, `prewarmed`). Null for legacy mailboxes.
    - `daily_send_limit` integer, nullable: Per-mailbox daily send cap, if configured.
    - `footer` string, nullable: HTML footer appended to outbound mail, if configured.
    - `imap_host` string, nullable: IMAP server hostname for this mailbox. Domains are distributed across multiple mail servers, so this is resolved per-mailbox — always connect to the host returned here, never a fixed hostname. Uses implicit TLS on `imap_port`. For workspace (Gmail) mailboxes this is `imap.gmail.com`.
    - `imap_port` integer: IMAP port (implicit TLS). Currently `993`.
    - `smtp_host` string, nullable: SMTP submission hostname for this mailbox, resolved per-mailbox (see `imap_host`). Uses implicit TLS on `smtp_port`. For workspace (Gmail) mailboxes this is `smtp.gmail.com`.
    - `smtp_port` integer: SMTP submission port (implicit TLS). Currently `465`.
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `meta` Meta
    - `request_id` string
    - `timestamp` string, date-time

## 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)