Remove member

To remove one or more members from a group use below API.

info

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

HTTP request#

curl -X GET "https://{api-base-url}/api/v1/group/removeParticipant?groupId=samplegroupId&groupMembers=77xxxxxx11"
-H "accept: */*"
-H "Authorization: xxxxxxxxxxxxxxxxxx"

Request Params#

ParamDataTypeRequiredDescription
groupIdStringYesId of the group
groupMembersStringYesUserIds of the members to be deleted

Responses#

If successful, this action removes the given members from the group.

{
"status": 200,
"data": {
"groupId": "samplegroupId", // String - group id
"groupName": "samplegroupname"// String - group name
},
"message": "Participants removed 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,
"message": "Error Message"
}