Archive Channel

Archives a channel.

Body Parameters

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 Response

Success

{
    "success": true
}

Error

Any of the following errors can occur:

  • Authorization: Requires an authentication token for the request to be made.

  • Room Archived: This occurs when the channel is already archived.

{
    "status": "error",
    "message": "You must be logged in to do this."
}

Change Log

Last updated

Rocket.Chat versions receive support for six months after release.