Remove users from group sonet_group.user.delete
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
sonetWho can execute the method: administrator
The method sonet_group.user.delete removes participants from a workgroup or project.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
GROUP_ID* |
Identifier of the workgroup or project. The identifier can be obtained using the sonet_group.get method. |
|
USER_ID* |
Identifier of the participant. The identifier can be obtained using the sonet_group.user.get method. |
You cannot remove the owner of the group or project and the scrum master.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"GROUP_ID":69,"USER_ID":[1271,1272]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sonet_group.user.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"GROUP_ID":69,"USER_ID":[1271,1272],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sonet_group.user.delete
try
{
const response = await $b24.callMethod(
'sonet_group.user.delete',
{
GROUP_ID: 69,
USER_ID: [1271, 1272]
}
);
const result = response.getData().result;
console.log('Users deleted from group:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'sonet_group.user.delete',
[
'GROUP_ID' => 69,
'USER_ID' => [1271, 1272]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting users from group: ' . $e->getMessage();
}
BX24.callMethod(
'sonet_group.user.delete',
{
GROUP_ID: 69,
USER_ID: [1271, 1272]
},
function(result)
{
if (result.error())
{
console.error(result.error(), result.error_description());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sonet_group.user.delete',
[
'GROUP_ID' => 69,
'USER_ID' => [1271, 1272]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": ["1271", "1272"],
"time": {
"start": 1773810480,
"finish": 1773810480.5882,
"duration": 0.5882,
"processing": 0.2973,
"date_start": "2026-03-18T08:48:00+02:00",
"date_finish": "2026-03-18T08:48:00+02:00",
"operating_reset_at": 1773811080,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array of user identifiers that were successfully deleted. An empty array means that there was an attempt to remove the owner of the group or project. |
|
time |
Information about the execution time of the request. |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "No permissions to update users role"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
— |
|
An incorrect |
|
— |
|
Insufficient rights to remove participants. |
|
— |
|
An empty or incorrect |
|
— |
|
Group or project with the specified |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Invite users to group sonet_group.user.invite
- Send a request to join the group sonet_group.user.request
- Add Users to Group sonet_group.user.add
- Change Role of Group Participants sonet_group.user.update
- Get the list of group participants sonet_group.user.get