Edit Communications of the humanresources.node.communication.edit

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.

Scope: humanresources

Who can execute the method: a user with the "Edit Departments" or "Edit Teams" permission

The method humanresources.node.communication.edit binds, unbinds, or creates a chat, channel, or collab for a department or team.

Method Parameters

Required parameters are marked with *

Name
type

Description

nodeId*
integer

Identifier of the department or team.

The identifier can be obtained using the humanresources.node.list method.

communicationType*
string

Type of communication.

Possible values:

  • CHAT — chat
  • CHANNEL — channel
  • COLLAB — collab

createDefault
boolean

Creates a default communication for the department or team.

Possible values:

  • true — create default communication
  • false — do not create default communication

Default is false

ids
array

Identifiers of communications to be bound.

Identifiers of chats and channels can be obtained using the im.recent.list method, and identifiers of collabs can be obtained using the socialnetwork.api.workgroup.list method.

removeIds
array

Identifiers of communications to be unbound.

Identifiers of related communications can be obtained using the humanresources.node.communication.list method.

withChildren
boolean

Applies the change to child departments and teams.

Possible values:

  • true — apply the change to child departments and teams
  • false — apply the change only to the department or team specified in the nodeId parameter

Default is false

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/humanresources.node.communication.edit
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"nodeId":15,"communicationType":"CHAT","ids":[21],"removeIds":[18],"createDefault":false,"withChildren":false}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/humanresources.node.communication.edit
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"nodeId":15,"communicationType":"CHAT","ids":[21],"removeIds":[18],"createDefault":false,"withChildren":false,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/humanresources.node.communication.edit
        
// 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
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type NodeCommunicationEditResult = {
          success: boolean
        }
        
        try {
          const response = await $b24.actions.v3.call.make<NodeCommunicationEditResult>({
            method: 'humanresources.node.communication.edit',
            params: {
              nodeId: 15,
              communicationType: 'CHAT',
              ids: [21],
              removeIds: [18],
              createDefault: false,
              withChildren: false,
            },
            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('Communication edited successfully:', result.success)
          }
        } 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 editNodeCommunication() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'humanresources.node.communication.edit',
                params: {
                  nodeId: 15,
                  communicationType: 'CHAT',
                  ids: [21],
                  removeIds: [18],
                  createDefault: false,
                  withChildren: false,
                },
                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('Communication edited successfully:', result.success)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', editNodeCommunication)
        </script>
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'humanresources.node.communication.edit',
                    [
                        'nodeId' => 15,
                        'communicationType' => 'CHAT',
                        'ids' => [21],
                        'removeIds' => [18],
                        'createDefault' => false,
                        'withChildren' => false,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

BX24.callMethod(
            'humanresources.node.communication.edit',
            {
                nodeId: 15,
                communicationType: 'CHAT',
                ids: [21],
                removeIds: [18],
                createDefault: false,
                withChildren: false
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'humanresources.node.communication.edit',
            [
                'nodeId' => 15,
                'communicationType' => 'CHAT',
                'ids' => [21],
                'removeIds' => [18],
                'createDefault' => false,
                'withChildren' => false,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP Status: 200

{
            "result": {
                "success": true
            },
            "time": {
                "start": 1780407100,
                "finish": 1780407100.186404,
                "duration": 0.18640398979187012,
                "processing": 0.1328411102294922,
                "date_start": "2026-06-02T16:31:40+02:00",
                "date_finish": "2026-06-02T16:31:40+02:00",
                "operating_reset_at": 1780407700,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the result of the operation

success
boolean

Value true if communications were changed

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error during request object validation",
                "validation": [
                    {
                        "message": "Parameter \"communicationType\" is required.",
                        "field": "communicationType"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error Description

How to Fix

nodeId

Parameter "nodeId" is required.

Provide the identifier of the department or team.

communicationType

Parameter "communicationType" is required.

Provide the type of communication.

communicationType

Invalid "communicationType" value. Allowed: CHAT, CHANNEL, COLLAB.

Provide one of the allowed values.

Data Not Found Errors

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error Description

How to Fix

nodeId

Object with identifier #ID# not found.

Specify an existing identifier of the department or team.

Access Errors

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error Description

How to Fix

-

Access denied.

Check the permission to modify communications of the department or team.

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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