Remove User From Group

Use this API to remove a user from the group

JSON Parameter Description:

JSON Parameter

Required

Description

userId

Yes

User unique identifier to be removed from group.

clientGroupId

Yes

Group unique identifier.

resetCount

No

To reset unread-count of removed user

📘

Application Bot

In case of Application Bot calling the API, Of-User-Id header is required.
Of-User-Id is the userId of the user on behalf of which application bot wants to remove members from the group.

🚧

Warning:

Only Group Admin can remove the group member from private groups; otherwise, following error will be displayed:

{
  "status":"error",
  "errorResponse":[
    {
      "errorCode":"AL-UN-01",
      "description":"unauthorized user",
      "displayMessage":"Unable to process"
    }
  ],
  "generatedAt":1452348983616  // time value at which response is generated from server
}
Language
Authentication
Click Try It! to start a request and see the response here!