Post
/api/v1/groups.delete
Delete a private room.
The following permissions are required:
delete-p
: To delete a private channel.delete-team-group
: To delete a private channel that is part of a team.
Changelog
Version | Description |
---|---|
0.71.0 | Removed group 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. You can find the IDs by using any of the following endpoints:
- Get List of User Groups: This endpoint returns all private channels in the workspace, if you have the required permissions to view them.
- Get Groups: This endpoint returns the private channels that you are a member of.
ExampleByehQjC44FwMeiLbX
roomName
string
Enter the room name. This parameter is required if no roomId
is provided.
Exampleprivate-abc
Responses
200
OK
Success
{
"success": true
}
object
success
boolean
400
Bad Request
No permission
{
"success": false,
"error": "Not allowed [error-not-allowed]",
"errorType": "error-not-allowed",
"details": {
"method": "eraseRoom"
}
}
object
success
boolean
error
string
errorType
string
details
object
method
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}
object
status
string
message
string