Skip to content
  • Auto
  • Light
  • Dark
Download Beeper

Archive or unarchive a chat

Deprecated
POST
/v0/archive-chat

Archive or unarchive a chat. Set archived=true to move to archive, archived=false to move back to inbox. Use POST /v1/chats/{chatID}/archive instead.

object
chatID
required

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

string
Example
!NCdzlIaMjZUmvmvyHU:beeper.com
archived

True to archive, false to unarchive

boolean
default: true

Tool executed successfully

object
success
required
boolean
error
string

Invalid request parameters

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Access token is missing or invalid

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Access token does not have the required scope

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Resource not found

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Unprocessable entity - validation error

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Too many requests - rate limit exceeded

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string

Internal server error

object
error
required

Error message

string
code

Error code

string
details

Additional error details

object
key
additional properties
string