Archive

API Reference

Chats

Archive or unarchive a chat

post/v0/archive-chat

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

Body ParametersExpand Collapse

chatID: string

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

archived: optional boolean

True to archive, false to unarchive

ReturnsExpand Collapse

BaseResponse

HTTPTypeScript

curl http://localhost:23373/v0/archive-chat \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN" \
    -d '{
          "chatID": "!NCdzlIaMjZUmvmvyHU:beeper.com"
        }'

200 example

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

Returns Examples

200 example

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