Groups resouce

Site group management - Delete user from a group

OVERVIEW

This API method removes a user from a group

Request URI

DELETE /api/3/sites/{siteid}/groups/{groupid}/users?userid={userid}

 

Request parameters

 

Parameter Value Description
siteid (required) integer The ID of the site. The siteid can be obtained by calling the Get site list API
groupid (required) integer The ID of the site group. The groupid can be obtained by calling the Get all site groups   API and for Admin GroupID Admin group representation consider -2 to -6 
userid (required) integer The ID of the user to be removed from the group. The userid can be obtained by calling Get site users API

Response 

The API returns a 200 OK if successful otherwise an error object and error code

Comments


0 Comments

Last Updated: Nov 08,2024