---
title: "Turn the Universal Inbox on or off"
method: POST
path: "/v1/account/universal-inbox"
tags: ["Account"]
---

# Turn the Universal Inbox on or off

`POST /v1/account/universal-inbox`

## Request

- Base URL: `https://api.winnr.app`
- URL: `https://api.winnr.app/v1/account/universal-inbox`
- Auth: HTTP bearer

Sets whether the account's inbox sync (the dashboard's Universal Inbox)
is on. This is the same switch as Settings > Universal Inbox in the
dashboard. Turning it off stops syncing incoming mail into the inbox;
mailboxes and the mail on them are untouched, and it can be turned back
on at any time. Idempotent.

`email.received` webhook events are produced by inbox sync, so turning
it off is refused with `409` while any **enabled** webhook endpoint
subscribes to `email.received` or `*`. Remove that event from the
endpoint (or disable the endpoint) first. Subscribing an endpoint to
`email.received`, or re-enabling one, turns inbox sync back on
automatically.

## Request body

- object
  - `enabled` boolean, required: true to turn inbox sync on, false to turn it off

## Response `200`

Setting applied (or already in that state)

- object
  - `meta` Meta
    - `request_id` string
    - `timestamp` string, date-time
  - `data` object
    - `enabled` boolean: The inbox sync setting after the call
    - `changed` boolean: False when the account was already in the requested state

## Other responses

- `400`: Validation error
- `401`: Authentication required or token invalid
- `403`: API token lacks write permission
- `409`: Turning the inbox off was refused because an enabled webhook endpoint subscribes to `email.received` (or `*`).

---

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