Set Connector Settings imconnector.connector.data.set

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

PHP

BX24.js

PHP CRest

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

const response = await $b24.callMethod('imconnector.connector.data.set', {
          CONNECTOR: 'myconnector',
          LINE: 107,
          DATA: {
            ID: 'channel-123',
            URL: 'https://example.com/chats/123',
            NAME: 'Support Channel',
          },
        });
        console.log(response.getData());

$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',
                ],
            ]
        );

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

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

Get Connector Status

Get List of Connectors

Set Connector Settings imconnector.connector.data.set

Method ParametersMethod Parameters

DATA ParameterDATA Parameter

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