Sign in
Groups

Bulk remove groups from users

Bulk remove groups from multiple users, users under specific admins, or all users.

  • group_ids: List of group IDs to remove (required)
  • users: Optional list of user IDs to remove the groups from
  • admins: Optional list of admin IDs — their users will be targeted

Notes:

  • If neither 'users' nor 'admins' are provided, groups will be removed from all users
  • Only existing user-group associations will be removed
  • Returns list of affected users (those who had groups removed)
post/api/groups/bulk/remove

Request body

group_idsinteger[] required
has_group_idsinteger[]
adminsinteger[]
usersinteger[]
dry_runboolean

Response

Success confirmation

{"stackTrail":"paths:/api/groups/bulk/remove:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.