Reference
Fuselage
Channel Create
Creates a new public channel, optionally including specified users. The channel creator is always included.
URL
Requires Auth
HTTP Method
/api/v1/channels.create
yes
POST

Payload

Argument
Example
Required
Description
name
channelname
Required
The name of the new channel
members
["rocket.cat"]
Optional Default: []
The users to add to the channel when it is created.
readOnly
true
Optional Default: false
Set if the channel is read only or not.

Example Call

1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
-H "Content-type: application/json" \
4
http://localhost:3000/api/v1/channels.create \
5
-d '{ "name": "channelname" }'
Copied!

Example Result

1
{
2
"channel": {
3
"_id": "ByehQjC44FwMeiLbX",
4
"name": "channelname",
5
"t": "c",
6
"usernames": [
7
"example"
8
],
9
"msgs": 0,
10
"u": {
11
"_id": "aobEdbYhXfu5hkeqG",
12
"username": "example"
13
},
14
"ts": "2016-05-30T13:42:25.304Z"
15
},
16
"success": true
17
}
Copied!

Change Log

Version
Description
0.13.0
Added
Last modified 8mo ago
Export as PDF
Copy link
Edit on GitHub