Create a group or project sonet_group.create

Scope: sonet

Who 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 `type`	Description
NAME* `string`	The name of the group or project
DESCRIPTION `string`	The description of the group or project
VISIBLE `string`	The visibility of the group in the list. Possible values: `Y` — the group is visible in the general list `N` — the group is hidden from the general list Default — `Y`. For extranet users, the value is forcibly set to `N`
OPENED `string`	Is the group open for free joining. Possible values: `Y` — the user can join the group without confirmation `N` — joining by invitation or request Default — `N`. For extranet users, the value is forcibly set to `N`
CLOSED `string`	Is the group archived. Possible values: `Y` — the group is archived `N` — the group is active Default — `N`
KEYWORDS `string`	Keywords separated by commas
INITIATE_PERMS `string`	Who can invite participants. Possible values: `A` — only the group owner `E` — owner and moderators `K` — all participants If the parameter is not provided, the default value is used: for intranet users — `K` for extranet users — `E`
PROJECT `string`	Create a project instead of a group. Possible values: `Y` — create a project `N` — create a group Default — `N`
PROJECT_DATE_START `datetime`	The project start date in ISO-8601 format
PROJECT_DATE_FINISH `datetime`	The project end date in ISO-8601 format
SCRUM_MASTER_ID `integer`	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 `integer`	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 `file`	The group's avatar in Base64 format
IMAGE_FILE_ID `integer`	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 `IMAGE_FILE_ID` and `IMAGE` are provided, `IMAGE_FILE_ID` takes precedence
SITE_ID `array`	A list of site IDs to which the group is linked Default — the current site
SUBJECT_ID `integer`	The identifier of the group's subject

Code examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'sonet_group.create',
                {
                    NAME: 'New Project',
                    PROJECT: 'Y',
                    VISIBLE: 'Y',
                    OPENED: 'N',
                    INITIATE_PERMS: 'K',
                    IMAGE: [
                        'avatar.png',
                        'iVBORw0KGgoAAAANSUhEUgAA...'
                    ]
                }
            );
            
            const result = response.getData().result;
            console.log('Created group with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('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>';

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 `type`	Description
result `integer`	The identifier of the created group or project
time `time`	Information about the execution time of the request

Error handling

HTTP status: 400

{
            "error": "",
            "error_description": "Cannot create group"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
—	`Incorrect input data`	Incorrect format of parameters provided
—	`You have no permissions to create a group`	Insufficient rights to create a group or project
—	`Cannot create group`	Failed to create a group or project
`ERROR_IMAGE_ID`	`Image is incorrect: Invalid file type`	An incorrect `IMAGE` was provided

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue learning

Overview of Methods

Modify Group or Project

Create a group or project sonet_group.create

Method parametersMethod parameters

Code examplesCode examples

Response handlingResponse handling

Returned dataReturned data

Error handlingError handling

Possible error codesPossible error codes

Statuses and System Error CodesStatuses and System Error Codes

Continue learningContinue learning