Close Channel

Prev Next
Post
/api/v1/channels.close

Remove a channel from the user's list of channels in the workspace sidebar. You can access it again from the Directory.

Changelog

Version Description
0.48.0 Added
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
Example
{
  "roomId": "ByehQjC44FwMeiLbX"
}
object
roomId
string Required

The channel ID that you want to close from your list.

Responses
200

OK

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

Bad Request

Channel is already closed
{
  "success": false,
  "error": "The channel, dlp, is already closed to the sender"
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string