Delete Group

Delete Group

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/api/v1/groups.delete

Delete a private group.

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.

ExampleByehQjC44FwMeiLbX

roomName

string

Enter the room name. This parameter is required if no roomId is provided.

Examplegeneral

Responses

200

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

Was this article helpful?