---
title: "Set the read state of an email"
method: PATCH
path: "/inbox/messages/{id}/read-state"
tags: ["inbox"]
---

# Set the read state of an email

`PATCH /inbox/messages/{id}/read-state`

## Request

- Base URL: `https://api.mailly.site` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mailly.site/inbox/messages/{id}/read-state`
- Auth: HTTP bearer

## Path parameters

- `id` string, required: Email ID

## Request body

- object
  - `is_read` boolean, required: true marks as read, false marks as unread

## Response `200`

Updated

- object
  - `success` boolean, required
  - `id` string, required
  - `is_read` boolean, required
  - `changed` boolean, required

## Other responses

- `400`: Invalid parameters
- `401`: Missing or invalid API key
- `404`: Resource not found
- `409`: Sent records cannot be modified
- `500`: Server error

---

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