Remove group member api

The "remove group member" API allows a group admin to remove a member from a group. This can help group admins to manage their group membership and ensure that the group is only accessible to authorized members.

Path Parameters

group_id integer required

group id

Query Parameters

client_auth_token string required

Client API token

Header Parameters

access-token string required

user access token

client string required

client access token

expiry string required
timestamp of token expiry
Example: 1531315250
token-type string required
access token type
Example: Bearer
uid string required
user uid
Example: user@quranreflect.com

application/json

Request Body

user_id integer

id of user to be removed

Responses

• 200
• 401
• 500

---

OK

Response Headers

application/json

Schema

Example (from schema)

member removed

---

Schema

success boolean
message string

{
  "success": true,
  "message": "string"
}

Remove User from groups API (success false)

{
  "success": true,
  "message": "User Naveed has been removed from page."
}

Unauthorized response, api will respond with this 401 eithr user is not logged in or do not have permission to perform some action. Like creating a post in a room, but user is not member of room.

System will also return 401 if api token is missing or invlaid.

application/json

Schema

Example (from schema)

not logged in

missing or invalid api key

---

Schema

errors string[]
status integer

Default value: 401

success boolean

Default value: false

{
  "errors": [
    "string"
  ],
  "status": 401,
  "success": false
}

{
  "errors": [
    "You need to sign in or sign up before continuing."
  ],
  "success": false
}

{
  "message": "You don't have permission!",
  "status": 401,
  "success": false
}

Internal server error, api will respond with 500 if something went wrong processing the request.

application/json

Schema

Example (from schema)

---

Schema

success boolean required

Default value: false

message string required

Default value: internal server error

error message

{
  "success": false,
  "message": "internal server error"
}

Loading...