Skip to content
Beeper Developer Docs
Download Beeper
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 it to Archive, or archived=false to move it back to the inbox.

ParametersExpand Collapse
chatID: string

Chat ID. Input routes also accept the local chat ID from this installation when available.

body: ChatArchiveParams { archived }
archived?: boolean

True to archive, false to unarchive

Archive or unarchive a chat

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

const client = new BeeperDesktop({
  accessToken: process.env['BEEPER_ACCESS_TOKEN'], // This is the default and can be omitted
});

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