# Mark an item read, unread or archived

> Page: https://docs.flung.dev/reference/api/patch-v1-inbox-id. Index of every page: https://docs.flung.dev/llms.txt

Mark an item read, unread or archived.

`PATCH /v1/inbox/{id}`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Mark an item read, unread or archived. |
| What does it need? | An API key or an OAuth access token. |
| What does it take? | A JSON body with the fields below, and `id` in the path. |
| What does it return? | Status 200 with a body of type [`InboxItem`](https://docs.flung.dev/reference/api/schemas.md#inboxitem). |
| In the SDK? | `flung.inbox.update()` |
| What can go wrong? | `401` Missing, unknown, revoked or expired API key; `404` No such item in this workspace; `422` The request failed validation; `429` Too many requests for this credential; wait for `retry-after` seconds. Every failure has the same [error shape](https://docs.flung.dev/reference/api/errors.md). |

## Example

**curl**

```bash
curl -X PATCH 'https://api.flung.dev/v1/inbox/ibx_aaaaaaaaaaaaaaaaaaaaaaaa' \
  --header "Authorization: Bearer $FLUNG_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "unread"
}'
```

**TypeScript**

```ts
import { Flung } from '@flung.dev/sdk'

const flung = new Flung({ apiKey: process.env.FLUNG_API_KEY! })
const result = await flung.inbox.update({
  id: 'ibx_aaaaaaaaaaaaaaaaaaaaaaaa',
  status: 'unread',
})
```

**fetch**

```js
const response = await fetch('https://api.flung.dev/v1/inbox/ibx_aaaaaaaaaaaaaaaaaaaaaaaa', {
  method: 'PATCH',
  headers: {
    'Authorization': `Bearer ${process.env.FLUNG_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    status: 'unread',
  }),
})
if (!response.ok) throw new Error((await response.json()).error.message)
const result = await response.json()
```

A successful answer looks like this:

```json
{
  "id": "ibx_aaaaaaaaaaaaaaaaaaaaaaaa",
  "accountId": "string",
  "platform": "x",
  "kind": "comment",
  "status": "unread",
  "text": "string",
  "author": {
    "id": "string",
    "name": "string",
    "handle": "string"
  },
  "url": "string",
  "platformItemId": "string",
  "platformPostId": "string",
  "targetId": "string",
  "createdAt": "2026-11-01T09:00:00.000Z",
  "repliedAt": "2026-11-01T09:00:00.000Z"
}
```

## Path parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | `string` | yes |  |

## Request body

The body has the type an object, with the fields below.

| Field | Type | Required | Description |
|---|---|---|---|
| `status` | `"unread" \| "read" \| "archived"` | yes |  |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | The item. | [`InboxItem`](https://docs.flung.dev/reference/api/schemas.md#inboxitem) |
| 401 | Missing, unknown, revoked or expired API key. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 404 | No such item in this workspace. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 422 | The request failed validation. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 429 | Too many requests for this credential; wait for `retry-after` seconds. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |

## Response body

A 200 answer has the type [`InboxItem`](https://docs.flung.dev/reference/api/schemas.md#inboxitem).

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | `string` | yes |  |
| `accountId` | `string` | yes |  |
| `platform` | `Platform` | yes |  |
| `kind` | `"comment" \| "mention"` | yes | `comment`: a reply to one of the account's posts. `mention`: the account named elsewhere. |
| `status` | `"unread" \| "read" \| "replied" \| "archived"` | yes |  |
| `text` | `string` | yes |  |
| `author` | `object` | yes |  |
| `author.id` | `string` | yes |  |
| `author.name` | `string \| null` | yes |  |
| `author.handle` | `string \| null` | yes |  |
| `url` | `string \| null` | yes |  |
| `platformItemId` | `string` | yes |  |
| `platformPostId` | `string \| null` | yes | The platform post it answers. |
| `targetId` | `string \| null` | yes | The Flung post target it answers, when that post went out through Flung. |
| `createdAt` | `string` | yes |  |
| `repliedAt` | `string \| null` | yes |  |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.flung.dev/reference/api.md) | Every endpoint |
| [Schemas](https://docs.flung.dev/reference/api/schemas.md) | Every request and response type |
| [Errors](https://docs.flung.dev/reference/api/errors.md) | Every error code and what to do about it |