Set Connector Settings imconnector.connector.data.set

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: imopenlines

Who can execute the method: any user

The method imconnector.connector.data.set sets the channel settings in an external system for a custom connector and the specified open line.

The method works only in the context of the application.

Method Parameters

Required parameters are marked with *

Name
type

Description

CONNECTOR*
string

String code of the connector specified in the ID parameter when calling imconnector.register

LINE*
integer

Identifier of the open line.

The identifier can be obtained using the methods imopenlines.config.get and imopenlines.config.list.get

DATA*
object

Object containing the channel settings in the external system. The method does not support setting or modifying a single field separately: settings are written and overwritten through this object as a whole.

The structure of the object is described in detail below

DATA Parameter

Name
type

Description

ID
string

Identifier of the channel in the external system, for example channel-123.

The identifier should be taken from the external system. If none is available, use a unique key, such as a combination of the connector ID and line: myconnector_line107

URL
string

Full link to the chat or channel in the external system

URL_IM
string

Full link to the chat in the operator interface format. If there is no separate link for the operator, use the value of URL

NAME
string

Name of the channel for display in the interface

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "CONNECTOR":"myconnector",
            "LINE":107,
            "DATA":{
              "ID":"channel-123",
              "URL":"https://example.com/chats/123",
              "NAME":"Support Channel"
            },
            "auth":"**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imconnector.connector.data.set
        
// 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<boolean>({
            method: 'imconnector.connector.data.set',
            params: {
              CONNECTOR: 'myconnector',
              LINE: 107,
              DATA: {
                ID: 'channel-123',
                URL: 'https://example.com/chats/123',
                NAME: 'Support Channel',
              },
            },
            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('Connector data saved:', 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 setConnectorData() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'imconnector.connector.data.set',
                params: {
                  CONNECTOR: 'myconnector',
                  LINE: 107,
                  DATA: {
                    ID: 'channel-123',
                    URL: 'https://example.com/chats/123',
                    NAME: 'Support Channel',
                  },
                },
                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('Connector data saved:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', setConnectorData)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.imconnector.connector.data.set(
                connector="myconnector",
                line=107,
                data={
                    "ID": "channel-123",
                    "URL": "https://example.com/chats/123",
                    "NAME": "Support Channel",
                },
            ).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}")
        
$result = $b24Service->core->call(
            'imconnector.connector.data.set',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'DATA' => [
                    'ID' => 'channel-123',
                    'URL' => 'https://example.com/chats/123',
                    'NAME' => 'Support Channel',
                ],
            ]
        );
        
BX24.callMethod(
          'imconnector.connector.data.set',
          {
            CONNECTOR: 'myconnector',
            LINE: 107,
            DATA: {
              ID: 'channel-123',
              URL: 'https://example.com/chats/123',
              NAME: 'Support Channel',
            },
          },
          function(result) {
            console.log(result.data());
          }
        );
        
$result = CRest::call(
            'imconnector.connector.data.set',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'DATA' => [
                    'ID' => 'channel-123',
                    'URL' => 'https://example.com/chats/123',
                    'NAME' => 'Support Channel',
                ],
            ]
        );
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imconnector.connector.data.set", b24.Params{
        	"CONNECTOR": "myconnector",
        	"LINE":      107,
        	"DATA": b24.Params{
        		"ID":   "channel-123",
        		"URL":  "https://example.com/chats/123",
        		"NAME": "Support Channel",
        	},
        })
        if err != nil {
        	return fmt.Errorf("imconnector.connector.data.set: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)
        

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
            "start": 1738065600.11,
            "finish": 1738065600.20,
            "duration": 0.09,
            "processing": 0.04,
            "date_start": "2025-01-28T12:00:00+00:00",
            "date_finish": "2025-01-28T12:00:00+00:00"
            }
        }
        

Returned Data

Name
type

Description

result
boolean

true if the data is saved

time
time

Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Argument 'DATA' is null or empty"
        }
        

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

Status

Code

Description

Value

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

Method called outside the application context OAuth

400

ERROR_ARGUMENT

Argument 'CONNECTOR' is null or empty

CONNECTOR not provided

400

ERROR_ARGUMENT

Argument 'LINE' is null or empty

LINE not provided

400

ERROR_ARGUMENT

Argument 'DATA' is null or empty

DATA not 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