Reference
Fuselage
Channel Rename
Changes the name of the channel.
URL
Requires Auth
HTTP Method
/api/v1/channels.rename
yes
POST

Payload

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The channel's id
name
new-name
Required
The new name the channel will have, it cannot be the same as another or the existing name

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.rename \
5
-d '{ "roomId": "ByehQjC44FwMeiLbX", "name": "new-name" }'
Copied!

Example Result

1
{
2
"channel": {
3
"_id": "ByehQjC44FwMeiLbX",
4
"name": "new-name",
5
"t": "c",
6
"usernames": [
7
"testing1"
8
],
9
"msgs": 4,
10
"u": {
11
"_id": "aobEdbYhXfu5hkeqG",
12
"username": "testing1"
13
},
14
"ts": "2016-12-09T15:08:58.042Z",
15
"ro": false,
16
"sysMes": true,
17
"_updatedAt": "2016-12-09T15:57:44.686Z"
18
},
19
"success": true
20
}
Copied!

Change Log

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