Send a request to join the group sonet_group.user.request
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: a user with access to the group or project
The method sonet_group.user.request sends a request from the current user to join 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. |
|
MESSAGE |
Text of the request to join. |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"GROUP_ID":69,"MESSAGE":"Please add me to the project"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sonet_group.user.request
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"GROUP_ID":69,"MESSAGE":"Please add me to the project","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sonet_group.user.request
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'sonet_group.user.request',
params: {
GROUP_ID: 69,
MESSAGE: 'Please add me to the project',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Request sent:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function requestGroupJoin() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sonet_group.user.request',
params: {
GROUP_ID: 69,
MESSAGE: 'Please add me to the project',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Request sent:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', requestGroupJoin)
</script>
try {
$response = $b24Service
->core
->call(
'sonet_group.user.request',
[
'GROUP_ID' => 69,
'MESSAGE' => 'Please add me to the project'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error requesting group join: ' . $e->getMessage();
}
BX24.callMethod(
'sonet_group.user.request',
{
GROUP_ID: 69,
MESSAGE: 'Please add me to the project'
},
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.request',
[
'GROUP_ID' => 69,
'MESSAGE' => 'Please add me to the project'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": true,
"time": {
"start": 1773810600,
"finish": 1773810600.5026,
"duration": 0.5026,
"processing": 0.2404,
"date_start": "2026-03-18T08:50:00+02:00",
"date_finish": "2026-03-18T08:50:00+02:00",
"operating_reset_at": 1773811200,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
|
|
time |
Information about the request execution time. |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Socialnetwork group not found"
}
|
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 |
|
— |
|
The group or project was not found or is unavailable to the current user. |
|
— |
|
Failed to send the request to join. |
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 |