Archive

API Reference

Chats

Archive or unarchive a chat

client.chats.archive(stringchatID, ChatArchiveParams { archived } body?, RequestOptionsoptions?): void

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

chatID: string

Unique identifier of the chat.

body: ChatArchiveParams { archived }

archived?: boolean

True to archive, false to unarchive

Archive or unarchive a chat

typescript

• http
• typescript
• python
• go

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop({
  accessToken: 'My Access Token',
});

await client.chats.archive('!NCdzlIaMjZUmvmvyHU:beeper.com');

Returns Examples