---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Mark read on an inbox item"
description: "`notify.inbox_items.mark_read` (POST /v1/{name}:markRead): Marks an inbox item read."
type: reference
product: notifications
summary: "Marks an inbox item read."
updated: 2026-09-28
nav: false
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Marks an inbox item read.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:markRead`
- **Scope** `notify:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [inbox_items](/docs/api/inbox_items)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the inbox item. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/inbox_items/{inbox_item}`. |
| `uid` | `string` | `ibx_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `message` | `string` | The Message that produced it. Output only. |
| `title` | `string` | The rendered title. Output only. |
| `body` | `string` | The rendered body. Output only. |
| `action_uri` | `string` | Where the item links. Output only. |
| `state` | `InboxItemState` | Read, unread, or archived. Output only. One of `unread`, `read`, `archived`. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:markRead" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**TypeScript**

```ts
const response = await sylphx.notify.inboxItems.markRead({ name: 'orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item' })
```

**Rust**

```rust
let mut req = sylphx::notify::MarkInboxItemReadRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item".to_string();
let response = sx.notify().inbox_items().mark_read(req).await?;
```

**CLI**

```bash
sylphx notify inbox-items mark-read orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item
```

**MCP**

```json
{ "method_id": "notify.inbox_items.mark_read", "args": {"name":"orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item"} }
```