---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Inbox items"
description: "The `inbox_items` collection of Sylphx Notify: An Inbox Item is one entry of a recipient's in-app feed."
type: reference
product: notifications
summary: "An Inbox Item is one entry of a recipient's in-app feed."
updated: 2026-09-28
order: 900
---

> **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.

An Inbox Item is one entry of a recipient's in-app feed. Clients receive it live over an Events Realtime Channel and page it here.

**Service** Sylphx Notify · **Resource type** `notify.sylphx.com/InboxItem` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/inbox_items/{inbox_item}` · **Shape** `record`

## Fields

| 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`. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/inbox_items#get) | Gets an inbox item. |
| `GET` | [`list`](/docs/api/inbox_items#list) | Lists inbox items. |
| `POST` | [`mark_read`](/docs/api/inbox_items#mark-read) | Marks an inbox item read. |
| `POST` | [`mark_unread`](/docs/api/inbox_items#mark-unread) | Marks an inbox item unread. |
| `POST` | [`archive`](/docs/api/inbox_items#archive) | Archives an inbox item. |

## get

Gets an inbox item.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/inbox_items/get)

## list

Lists inbox items.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items` · scope `notify:read` · effect `read` · paginated · [Request, response and examples](/docs/api/inbox_items/list)

## mark_read

Marks an inbox item read.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:markRead` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/inbox_items/mark_read)

## mark_unread

Marks an inbox item unread.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:markUnread` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/inbox_items/mark_unread)

## archive

Archives an inbox item.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:archive` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/inbox_items/archive)