Login
    Contents x
    Archive a Group
      • Print
      • Dark
        Light
      • PDF
      Contents

      Archive a Group

        • Print
        • Dark
          Light
        • PDF
        Article summary

        Post
        /api/v1/groups.archive

        Archive a group you belong to.

        Changelog

        VersionDescription
        0.48.0Added
        Header parameters
        X-Auth-Token
        stringRequired

        The authToken of the authenticated user.

        ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
        X-User-Id
        stringRequired

        The userId of the authenticated user.

        ExamplerbAXPnMktTFbNpwtJ
        Body parameters
        object
        roomId
        string

        The group ID that you want to archive.

        ExampleByehQjC44FwMeiLbX
        Responses
        200

        OK

        Success
        {
  "success": true
}
        object
        success
        boolean
        401

        Unauthorized

        Authorization Error
        {
  "status": "error",
  "message": "You must be logged in to do this."
}
        object
        status
        string
        message
        string
        Was this article helpful?
        What's Next
        Rocket.Chat versions receive support for six months after release.
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.
        Logout