Reference
Fuselage
Channel Archive

Channel Archive

Archives a channel.
URL
Requires Auth
HTTP Method
/api/v1/channels.archive
yes
POST

Payload

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The channel's id

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

Example Result

1
{
2
"success": true
3
}
Copied!

Bad Request Example Result

If the channel is already archived, it will return a 400 bad request status.
1
{
2
"success": false,
3
"error": "The channel, {Channel name}, is archived [error-room-archived]",
4
"errorType": "error-room-archived"
5
}
Copied!

Change Log

Version
Description
0.48.0
Added
Last modified 8mo ago