Create a group or project sonet_group.create
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
sonetWho can execute the method: a user with the right to create a group or project
The method sonet_group.create creates a workgroup or project.
Method parameters
Required parameters are marked with *
|
Name |
Description |
|
NAME* |
The name of the group or project |
|
DESCRIPTION |
The description of the group or project |
|
VISIBLE |
The visibility of the group in the list. Possible values:
Default — |
|
OPENED |
Is the group open for free joining. Possible values:
Default — |
|
CLOSED |
Is the group archived. Possible values:
Default — |
|
KEYWORDS |
Keywords separated by commas |
|
INITIATE_PERMS |
Who can invite participants. Possible values:
If the parameter is not provided, the default value is used:
|
|
PROJECT |
Create a project instead of a group. Possible values:
Default — |
|
PROJECT_DATE_START |
The project start date in ISO-8601 format |
|
PROJECT_DATE_FINISH |
The project end date in ISO-8601 format |
|
SCRUM_MASTER_ID |
The identifier of the scrum master if the project is created as scrum. The user ID can be obtained using the user.get method |
|
OWNER_ID |
The identifier of the owner. The user ID can be obtained using the user.get method. Specifying the owner is available only to administrators. For all others, the current user automatically becomes the owner |
|
IMAGE |
The group's avatar in Base64 format |
|
IMAGE_FILE_ID |
The file ID from Drive for setting the avatar. The file ID can be obtained using the disk.storage.getchildren and disk.folder.getchildren methods. If both |
|
SITE_ID |
A list of site IDs to which the group is linked Default — the current site |
|
SUBJECT_ID |
The identifier of the group's subject |
Code examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"New Project","PROJECT":"Y","VISIBLE":"Y","OPENED":"N","INITIATE_PERMS":"K","IMAGE":["avatar.png","iVBORw0KGgoAAAANSUhEUgAA..."]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sonet_group.create
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"New Project","PROJECT":"Y","VISIBLE":"Y","OPENED":"N","INITIATE_PERMS":"K","IMAGE":["avatar.png","iVBORw0KGgoAAAANSUhEUgAA..."],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sonet_group.create
// 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<number>({
method: 'sonet_group.create',
params: {
NAME: 'New project',
PROJECT: 'Y',
VISIBLE: 'Y',
OPENED: 'N',
INITIATE_PERMS: 'K',
IMAGE: [
'avatar.png',
'iVBORw0KGgoAAAANSUhEUgAA...',
],
},
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('Created group or project ID:', 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 createGroup() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sonet_group.create',
params: {
NAME: 'New project',
PROJECT: 'Y',
VISIBLE: 'Y',
OPENED: 'N',
INITIATE_PERMS: 'K',
IMAGE: [
'avatar.png',
'iVBORw0KGgoAAAANSUhEUgAA...',
],
},
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('Created group or project ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', createGroup)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sonet_group.create(
name="New project",
project=True,
visible=True,
opened=False,
initiate_perms="K",
image=[
"avatar.png",
"iVBORw0KGgoAAAANSUhEUgAA...",
],
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'sonet_group.create',
[
'NAME' => 'New Project',
'PROJECT' => 'Y',
'VISIBLE' => 'Y',
'OPENED' => 'N',
'INITIATE_PERMS' => 'K',
'IMAGE' => [
'avatar.png',
'iVBORw0KGgoAAAANSUhEUgAA...'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating group: ' . $e->getMessage();
}
BX24.callMethod('sonet_group.create',
{
NAME: 'New Project',
PROJECT: 'Y',
VISIBLE: 'Y',
OPENED: 'N',
INITIATE_PERMS: 'K',
IMAGE: [
'avatar.png',
'iVBORw0KGgoAAAANSUhEUgAA...'
]
},
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.create',
[
'NAME' => 'New Project',
'PROJECT' => 'Y',
'VISIBLE' => 'Y',
'OPENED' => 'N',
'INITIATE_PERMS' => 'K',
'IMAGE' => [
'avatar.png',
'iVBORw0KGgoAAAANSUhEUgAA...'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sonet_group.create", b24.Params{
"NAME": "New Project",
"PROJECT": "Y",
"VISIBLE": "Y",
"OPENED": "N",
"INITIATE_PERMS": "K",
"IMAGE": []string{"avatar.png", "iVBORw0KGgoAAAANSUhEUgAA..."},
})
if err != nil {
return fmt.Errorf("sonet_group.create: %w", err)
}
var value b24.ID
if err := json.Unmarshal(res.Result, &value); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("result:", value)
Response handling
HTTP status: 200
{
"result": 77,
"time": {
"start": 1773921687,
"finish": 1773921688.071989,
"duration": 1.0719890594482422,
"processing": 1,
"date_start": "2026-03-19T15:01:27+02:00",
"date_finish": "2026-03-19T15:01:28+02:00",
"operating_reset_at": 1773922287,
"operating": 0.9421911239624023
}
}
Returned data
|
Name |
Description |
|
result |
The identifier of the created group or project |
|
time |
Information about the execution time of the request |
Error handling
HTTP status: 400
{
"error": "",
"error_description": "Cannot create group"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible error codes
|
Code |
Description |
Value |
|
— |
|
Incorrect format of parameters provided |
|
— |
|
Insufficient rights to create a group or project |
|
— |
|
Failed to create a group or project |
|
|
|
An incorrect |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |