---
title: "SDK: inbox"
description: "The inbox methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK: inbox

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `inbox` area has 6 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## inboxList

Your notification inbox, newest first, with the unread count

- Request: `GET` on `/v1/me/inbox`

```ts
inboxList(args?: { query?: { limit?: string; cursor?: string; unread?: string } }, options?: CallOptions): Promise<InboxListResponse>
```

## inboxPreferencesGet

How you are told about each kind of event: in the app, by email or not at all

- Request: `GET` on `/v1/me/notification-preferences`

```ts
inboxPreferencesGet(args?: Record<string, never>, options?: CallOptions): Promise<NotificationPreferences>
```

## inboxPreferencesPut

Set how you are told about the kinds of event you name

- Request: `PUT` on `/v1/me/notification-preferences`

```ts
inboxPreferencesPut(args?: { body?: Record<string, unknown> }, options?: CallOptions): Promise<NotificationPreferences>
```

## inboxRead

Mark one inbox item read

- Request: `POST` on `/v1/me/inbox/{inboxId}/read`

```ts
inboxRead(args: { inboxId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<InboxItem>
```

## inboxReadAll

Mark every item in your inbox read

- Request: `POST` on `/v1/me/inbox/read-all`

```ts
inboxReadAll(args?: { body?: Record<string, unknown> }, options?: CallOptions): Promise<InboxReadAllResponse>
```

## inboxSnooze

Hide one inbox item until a time you give

- Request: `POST` on `/v1/me/inbox/{inboxId}/snooze`

```ts
inboxSnooze(args: { inboxId: string; body: InboxSnoozeRequest }, options?: CallOptions): Promise<InboxItem>
```

Source: https://docs.overlane.app/sdk/inbox/index.mdx