Change group or project sonet_group.update

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: 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 -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
        
// 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.update',
            params: {
              GROUP_ID: 77,
              NAME: 'New project title',
            },
            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('Updated group 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 updateSonetGroup() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sonet_group.update',
                params: {
                  GROUP_ID: 77,
                  NAME: 'New project title',
                },
                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('Updated group ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSonetGroup)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.sonet_group.update(
                group_id=77,
                name="New project title",
            ).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.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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sonet_group.update", b24.Params{
        	"GROUP_ID": 77,
        	"NAME":     "New project title",
        })
        if err != nil {
        	return fmt.Errorf("sonet_group.update: %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": 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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

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: 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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning