Links
Comment on page

Channel Archive

Archives a channel.
URL
Requires Auth
HTTP Method
/api/v1/channels.archive
yes
POST

Payload

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The channel's id

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type: application/json" \
https://localhost:3000/api/v1/channels.archive \
-d '{ "roomId": "ByehQjC44FwMeiLbX" }'

Example Result

Success

{
"success": true
}

Error

Any of the following errors can occur on the endpoint.
  • Authorization: Requires an authentication token for the request to be made.
  • Room Archived: This occurs when the channel is already archived.
Authorization
Room Archived
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "The channel, add-room-websocket, is archived [error-room-archived]",
"errorType": "error-room-archived"
}

Change Log

Version
Description
0.48.0
Added
Last modified 2mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.