Archive

API Reference

Chats

Archive or unarchive a chat

client.chats.archive(ChatArchiveParamsbody, RequestOptionsoptions?): BaseResponse

post/v0/archive-chat

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

ParametersExpand Collapse

body: ChatArchiveParams

chatID: string

The identifier of the chat to archive or unarchive (accepts both chatID and local chat ID)

archived?: boolean

True to archive, false to unarchive

ReturnsExpand Collapse

BaseResponse

HTTPTypeScript

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

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

const baseResponse = await client.chats.archive({ chatID: '!NCdzlIaMjZUmvmvyHU:beeper.com' });

console.log(baseResponse.success);

200 example

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

Returns Examples

200 example

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