Update Source biconnector.source.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:
biconnectorWho can execute the method: A user who has both the "Access to BI Builder" and "Access to Analytics Hub" permissions
The method biconnector.source.update updates an existing source.
The method works only in the context of an application and changes only the sources that the application created itself. When called via a webhook, the method returns the ACCESS_DENIED error
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the source, can be obtained using the methods biconnector.source.list and biconnector.source.add |
|
fields* |
Object containing the updated data.
|
Parameter fields
|
Name |
Description |
|
title* |
New name of the source. Not required if only the |
|
description |
New description of the source |
|
active |
Source activity: If only the |
|
settings |
Values of the authorization parameters (detailed description) |
The method changes only the fields that were passed: whatever you did not pass stays unchanged in the source. This is also true for settings — the settings are merged by key, so pass only the authorization parameters that have to be changed.
The connectorId field is set once when the source is created and cannot be changed with the biconnector.source.update method.
On every update, Bitrix24 calls the connection check endpoint of the connector, even if the request contained no settings. The exception is a request that passes only the active field. If the external system does not respond, the method returns the SOURCE_UPDATE_CONNECTION_ERROR error.
Parameter settings
Pass settings as an object where the key is the code of a parameter declared by the connector and the value is what has to be substituted during the connection. The parameter codes can be retrieved with the biconnector.connector.list or biconnector.connector.get method. Keys that are absent from the connector description are dropped without an error.
If the connector declared parameters with the login and password codes, the field looks like this:
{
"settings": {
"login": "new_admin",
"password": "new_password"
}
}
In the response of the biconnector.source.get and biconnector.source.list methods, the same field arrives as an array of objects with the id, code, name, type, and value fields. Both forms are covered in the Settings Field section.
The biconnector.source.fields method declares settings as the array type, but the biconnector.source.update method accepts it as an object on input.
The biconnector.source.get and biconnector.source.list methods return the values of the authorization parameters in plain text, including passwords and tokens
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 4,
"fields": {
"title": "New source name",
"description": "Updated source description",
"settings": {
"login": "new_admin",
"password": "new_password"
}
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.source.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
// Methods of this section put errors inside result and answer with HTTP 200
type BiconnectorError = {
error: {
error: string
error_description: string
}
}
try {
const response = await $b24.actions.v2.call.make<boolean | BiconnectorError>({
method: 'biconnector.source.update',
params: {
id: 4,
fields: {
title: 'New source name',
description: 'Updated source description',
settings: {
login: 'new_admin',
password: 'new_password',
},
},
},
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
// The SDK sees HTTP 200 as success, so check the error inside result yourself
if (typeof result === 'object' && result !== null && 'error' in result) {
console.error(result.error.error, result.error.error_description)
} else {
console.info('Source updated:', 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 updateSource() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.source.update',
params: {
id: 4,
fields: {
title: 'New source name',
description: 'Updated source description',
settings: {
login: 'new_admin',
password: 'new_password',
},
},
},
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
// The SDK sees HTTP 200 as success, so check the error inside result yourself
if (result && result.error) {
console.error(result.error.error, result.error.error_description)
return
}
console.info('Source updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateSource)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.source.update(
bitrix_id=4,
fields={
"title": "New source name",
"description": "Updated source description",
"settings": {
"login": "new_admin",
"password": "new_password",
},
},
).response
result = bitrix_response.result
# Methods of this section put errors inside result and answer with HTTP 200
if isinstance(result, dict) and "error" in result:
print(
"BIconnector error",
f"error: {result['error']['error']}",
f"error_description: {result['error']['error_description']}",
sep="\n",
)
else:
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(
'biconnector.source.update',
[
'id' => 4,
'fields' => [
"title" => "New source name",
"description" => "Updated source description",
"settings" => [
"login" => "new_admin",
"password" => "new_password"
]
]
]
);
$result = $response
->getResponseData()
->getResult();
$data = $result;
// Methods of this section put errors inside result and answer with HTTP 200
if (isset($data['error'])) {
echo 'BIconnector error: ' . $data['error']['error'] . ': ' . $data['error']['error_description'];
} else {
echo 'Success: ' . print_r($data, true);
}
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'biconnector.source.update',
{
id: 4,
fields: {
"title": "New source name",
"description": "Updated source description",
"settings": {
"login": "new_admin",
"password": "new_password"
}
}
},
(result) => {
if (result.error()) {
console.error(result.error());
return;
}
const data = result.data();
// Methods of this section put errors inside result and answer with HTTP 200
if (data && data.error) {
console.error(data.error.error, data.error.error_description);
return;
}
console.info(data);
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.source.update',
[
'id' => 4,
'fields' => [
'title' => 'New source name',
'description' => 'Updated source description',
'settings' => [
'login' => 'new_admin',
'password' => 'new_password'
]
]
]
);
// Methods of this section put errors inside result and answer with HTTP 200
if (isset($result['result']['error'])) {
echo 'BIconnector error: ' . $result['result']['error']['error']
. ': ' . $result['result']['error']['error_description'];
} else {
echo '<PRE>';
print_r($result);
echo '</PRE>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "biconnector.source.update", b24.Params{
"id": 4,
"fields": b24.Params{
"title": "New source name",
"description": "Updated source description",
"settings": b24.Params{
"login": "new_admin",
"password": "new_password",
},
},
})
if err != nil {
return fmt.Errorf("biconnector.source.update: %w", err)
}
// Methods of this section put errors inside result and answer with HTTP 200.
var apiErr struct {
Error *struct {
Error string `json:"error"`
Description string `json:"error_description"`
} `json:"error"`
}
if err := json.Unmarshal(res.Result, &apiErr); err == nil && apiErr.Error != nil {
return fmt.Errorf("biconnector.source.update: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}
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": 1725365418.056843,
"finish": 1725365419.671506,
"duration": 1.6146628856658936,
"processing": 1.3475170135498047,
"date_start": "2024-09-03T14:10:18+02:00",
"date_finish": "2024-09-03T14:10:19+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Update result. On a successful update, |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 200
{
"result": {
"error": {
"error": "VALIDATION_FIELDS_NOT_PROVIDED",
"error_description": "Fields not provided."
}
}
}
The method returns an error inside the result field and with HTTP status 200. Check result.error: the SDK wrappers parse only the top level of the response and treat such an error as a success
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Access denied. |
One of the two permissions is missing, BI Builder external data sources are not available on this Bitrix24, or the method was called via a webhook or outside the application context |
|
|
ID is missing. |
Identifier is not specified |
|
|
ID has to be a positive integer. |
Invalid ID format |
|
|
Fields not provided. |
Fields not passed in the request |
|
|
Unknown parameters: #LIST_OF_PARAMS# |
Unknown parameters detected: list |
|
|
Field "#TITLE#" is read only. |
Field #TITLE# is read-only and cannot be modified |
|
|
Field "#TITLE#" is immutable. |
Field #TITLE# is immutable |
|
|
Field "#TITLE#" must be of type #TYPE#. |
Field #TITLE# must be of type #TYPE# |
|
|
Source was not found. |
The source does not exist or belongs to another application |
|
|
Cannot update connection. |
The external system did not respond to the request to the connection check endpoint — the source was not updated |
|
Empty value |
All the fields are required. |
The required |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |