Change group or project sonet_group.update

Scope: sonet

Who can execute the method: administrator or owner of the group or project

The method sonet_group.update modifies the parameters of a workgroup or project.

Method Parameters

Required parameters are marked with *

Name `type`	Description
GROUP_ID* `integer`	Identifier of the group or project. The identifier can be obtained using the sonet_group.get method.
NAME `string`	New name.
DESCRIPTION `string`	New description.
VISIBLE `string`	Visibility of the group in the list. Possible values: `Y` — group is visible in the general list `N` — group is hidden from the general list For extranet users, the value is forcibly set to `N`.
OPENED `string`	Is the group open for free joining? Possible values: `Y` — user can join the group without confirmation `N` — joining by invitation or request For extranet users, the value is forcibly set to `N`.
CLOSED `string`	Is the group archived? Possible values: `Y` — group is archived `N` — active group.
KEYWORDS `string`	Keywords separated by commas.
INITIATE_PERMS `string`	Who can invite participants. Possible values: `A` — only the owner of the group `E` — owner and moderators `K` — all participants.
PROJECT_DATE_START `datetime`	Project start date in ISO-8601 format.
PROJECT_DATE_FINISH `datetime`	Project end date in ISO-8601 format.
OWNER_ID `integer`	New owner of the group. The user identifier can be obtained using the user.get method.
IMAGE `file`	New group avatar in Base64 format.
IMAGE_FILE_ID `integer`	File identifier from Drive for setting the avatar. The file identifier can be obtained using the disk.storage.getchildren and disk.folder.getchildren methods. To delete the avatar, pass `IMAGE_FILE_ID: 0`. The avatar will be removed even if `IMAGE` is passed simultaneously; it will not be used.
SITE_ID `array`	List of sites to which the group is linked.

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 '{"GROUP_ID":77,"NAME":"New project title"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sonet_group.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"GROUP_ID":77,"NAME":"New project title","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sonet_group.update

try
        {
            const response = await $b24.callMethod(
                'sonet_group.update',
                {
                    GROUP_ID: 77,
                    NAME: 'New project title'
                }
            );
            
            const result = response.getData().result;
            console.log('Updated group with ID:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sonet_group.update',
                    [
                        'GROUP_ID' => 77,
                        'NAME' => 'New project title'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating group: ' . $e->getMessage();
        }

BX24.callMethod('sonet_group.update',
            {
                GROUP_ID: 77,
                NAME: 'New project title'
            }, 
            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.update',
            [
                'GROUP_ID' => 77,
                'NAME' => 'New project title'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": 77,
            "time": {
                "start": 1773923568,
                "finish": 1773923568.505599,
                "duration": 0.5055990219116211,
                "processing": 0,
                "date_start": "2026-03-19T15:32:48+01:00",
                "date_finish": "2026-03-19T15:32:48+01:00",
                "operating_reset_at": 1773924168,
                "operating": 0.3419780731201172
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the updated group or project.
time `time`	Information about the request execution time.

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Wrong group ID"
        }

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
—	`Wrong group ID`	Incorrect `GROUP_ID` provided.
—	`User has no permissions to update group`	Insufficient rights to modify the group or project.
—	`Cannot update group`	Failed to update the group or project.
`ERROR_IMAGE_ID`	`Image is incorrect: Invalid file type`	Incorrect `IMAGE` 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

Create Group or Project

Retrieve Workgroup Data

Change group or project sonet_group.update

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