WebsiteCommunityUser Documentation Free Trial
Search…
Rocket.Chat Developer
Quick Start
Choosing a Deployment Host
Setting up your Development Environment
Rocket.Chat
Environment Setup
Repository Structure
Deeplink
Two Factor Authentication
Embedded Layout
White Labelling Rocket.Chat
Iframe Integration
Contribute to Rocket.Chat
Mobile App
Mobile App Environment Setup
Testing your Mobile App
Mobile App White Labelling
Mobile App FAQs
Desktop App
Desktop App Environment Setup
Developing your Desktop App
Debugging your Desktop App
Desktop App White Labelling
Omnichannel
Omnichannel Environment Setup
Developing Omnichannel Apps
Livechat Widget Development and Customization
Omnichannel White Labelling
Omnichannel FAQs
Apps Engine
Rocket.Chat App
Rocket.Chat Apps Engine
Getting Started
Adding Features
Testing your App
Sample App Snippets
Slack Compatibility
App Submission to the Marketplace
Apps-Engine API Reference
Bots
Bots Development Environment Setup
Bots Architecture
Creating Your Own Bot From Scratch
Bots FAQs
Reference
Database Schema
Environment variables
API
Deprecation
Schema Definition
Schema Definition v2 (Draft)
Realtime API
REST API
Endpoints
Omnichannel
Team Collaboration Endpoints
Assets Endpoints
Auto Translate Endpoints
Banners Endpoints
Channels Endpoints
Channel Add All
Channel Add Leader
Channel Add Moderator
Channel Add Owner
Channel Anonymous Read
Channel Archive
Channel Close
Channel Counters
Channel Create
Channel Delete
Channel Files
Channel History
Channel Info
Channel Invite
Channel Join
Channel Kick
Channel Leave
Channel List Joined
Channel List
Channel Members List
Channel messages
Channel Moderators List
Channel Online
Channel Open
Channel Remove Leader
Channel Remove Moderator
Channel Remove Owner
Channel Rename
Channel Roles
Channel Set Announcement
Channel Set Custom Fields
Channel Set Default
Channel Set Description
Channel Set Join Code
Channel Set Purpose
Channel Set Read Only
Channel Set Topic
Channel Set Type
Channel Unarchive
Get all the mentions of a channel
Get Integrations of channel
Convert channel to team
Chat Endpoints
Cloud Endpoints
Commands Endpoints
Custom Sounds Endpoints
Custom User Status Endpoints
DNS Endpoints
E2E Endpoints
Email Inbox Endpoints
Custom Emoji Endpoints
Groups Endpoints
IM Endpoints
Import Endpoints
Instances Endpoints
Integration Endpoints
Invite Endpoints
Miscellaneous Endpoints
OAuthApps Endpoints
Permissions Endpoints
Push Token Endpoints
Roles Endpoints
Rooms Endpoints
Settings Endpoints
Stats Endpoints
Subscriptions Endpoints
Teams Endpoints
Users Endpoints
Video Conference Endpoints
Webdav Endpoint
Other Important Endpoints
Apps Endpoints
Avatars
Livechat Widget API
Fuselage
Contributing
Powered By GitBook
Convert channel to team
Convert a channel to team
URL
Requires Auth
HTTP Method
/api/v1/channels.convertToTeam
yes
POST

Headers

Argument
Example
Required
Description
X-User-Id
myuser-name
Required
Your username hash (returned after you log in through the API)
X-Auth-Token
myauth-token
Required
Your token (returned after you log in through the API)

Query Parameters

Argument
Example
Required
Description
channelName
documentation-team
Required
The channel's name
OR
​
​
​
channelId
ByehQjC44FwMeiLbX
Required
The channel's id

Example Call

1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
http://localhost:3000/api/v1/channels.channels.convertToTeam
4
-d '{ "channelName": "documentation-team" }'
Copied!

Example Result

1
{
2
"team": {
3
"_id": "612b8ae982d286c3d1f5db31",
4
"name": "documentation-team",
5
"type": 0,
6
"createdAt": "2021-08-29T13:26:01.750Z",
7
"createdBy": {
8
"_id": "JxemcN9PDCdfzJeZr",
9
"username": "renato.becker"
10
},
11
"_updatedAt": "2021-08-29T13:26:01.750Z",
12
"roomId": "GwktYAajqw4RiWiBK"
13
},
14
"success": true
15
}
Copied!
Previous
Get Integrations of channel
Next
Chat Endpoints
Last modified 3mo ago
Export as PDF
Copy link
Edit on GitHub
Contents
Headers
Query Parameters
Example Call
Example Result