Post
/api/v1/channels.delete
Delete a channel. Any of the permssions are required:
delete-c
: Delete a public channel.delete-team-channel
: Delete a channel part of a team. You also need thedelete-c
permission.
Changelog
Version | Description |
---|---|
0.71.0 | Removed channel property |
0.49.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
object
roomId
string
Enter the room ID. This parameter is required if no roomName
is provided.
ExampleByehQjC44FwMeiLbX
roomName
string
Enter the room name. This parameter is required if no roomId
is provided.
Examplegeneral
Responses
200
OK
Success
{
"success": true
}
object
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}
object
status
string
message
string