sonet-group-update.md

Change group or project sonet_group.update

{% note tip "" %}

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.

{% endnote %}

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

{% include Note on required parameters %}

#| || 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

{% include Note on examples %}

{% list tabs %}

• cURL (Webhook)

  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 (OAuth)

  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

• JS (TS)

  // 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)
  }

• JS (UMD)

  <!-- 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>

• PHP

  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.js

  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());
          }
      }
  );

• PHP CRest

  require_once('crest.php');
  
  $result = CRest::call(
      'sonet_group.update',
      [
          'GROUP_ID' => 77,
          'NAME' => 'New project title'
      ]
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

• Go

  // 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)

{% endlist %}

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"
}

{% include notitle error handling %}

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. || |#

{% include system errors %}

Continue Learning

• {#T}
• {#T}
• {#T}
• {#T}
• {#T}