Skip to main content
POST
/
v2
/
GroupDeleteUser
Remove user from group
curl --request POST \
  --url http://localhost:3000/v2/GroupDeleteUser \
  --header 'Content-Type: application/json' \
  --header 'X-Bunker-Token: <api-key>' \
  --data '
{
  "mode": "login",
  "identity": "<string>",
  "groupid": 123,
  "groupname": "<string>",
  "request_metadata": {}
}
'
{
  "status": "ok"
}

Authorizations

X-Bunker-Token
string
header
required

API token for authentication

Body

application/json
mode
enum<string>
required

Mode of user identification

Available options:
login,
token,
email,
phone,
custom
identity
string
required

User identifier corresponding to the mode

groupid
integer

ID of the group

groupname
string

Name of the group

request_metadata
object

Additional metadata for the request

Response

200 - application/json

User removed from group successfully

status
string
Example:

"ok"