API Reference

Chats

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Archive or unarchive a chat

chats.archive(strchat_id, ChatArchiveParams**kwargs)

POST/v1/chats/{chatID}/archive

Archive or unarchive a chat. Set archived=true to move to archive, archived=false to move back to inbox

ParametersExpand Collapse

chat_id: str

Unique identifier of the chat.

archived: Optional[bool]

True to archive, false to unarchive

Archive or unarchive a chat

Python

HTTP

TypeScript

Python

Go

CLI Tool

PHP

import os
from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token=os.environ.get("BEEPER_ACCESS_TOKEN"),  # This is the default and can be omitted
)
client.chats.archive(
    chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com",
)

Returns Examples