Archive

API Reference

Chats

Archive or unarchive a chat

chats.archive(strchat_id, ChatArchiveParams**kwargs) -> BaseResponse

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

ReturnsExpand Collapse

class BaseResponse: …

success: bool

error: Optional[str]

Archive or unarchive a chat

python

• http
• typescript
• python
• go

from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token="My Access Token",
)
base_response = client.chats.archive(
    chat_id="!NCdzlIaMjZUmvmvyHU:beeper.com",
)
print(base_response.success)

200 example

{
  "success": true,
  "error": "error"
}

Returns Examples

200 example

{
  "success": true,
  "error": "error"
}