Delete group

To delete an existing group use below API.

info

{api-base-url} can be obtained from the MirrorFly console.

Note : You have to leave the group before calling this API.

HTTP request#

curl -X DELETE "https://{api-base-url}/api/v1/group/deleteGroup"
--header "accept: */*"
--header "Authorization: xxxxxxxxxxxxxxxxxx"
--form "groupId=":groupId""

Request Params#

ParamDataTypeRequiredDescription
groupIdStringYesId of the group to be deleted

Responses#

If successful, this action deletes the given group.

{
"status": 200,
"data": {
"groupId": "groupId",
"participant": "participant"
},
"message": "Group deleted successfully"
}

Error#

In the case of an error, an error object like below is returned.

When the token passed in Headers is expired

{
"status": 401,
"message": "Token Expired"
}

In the case of a Bad Request, an error message is returned

{
"status": 400,
"data": {
"groupId": "groupId",
"participant": "participant"
},
"message": "Error message"
}