Update Table Columns biconnector.table.fields.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 biconnector.table.fields.update method updates the composition of columns of an existing table. It does not change the field schema of the "table" object itself — that schema is returned by the biconnector.table.fields method.
The method works only in the context of an application and changes only the tables 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* |
Table identifier, can be obtained with the biconnector.table.list or biconnector.table.add method |
|
add |
Array of columns to add. Each element is an object with three required keys:
Visibility is not set for a column being added: new columns are created visible |
|
update |
Array of columns to change. Each element is an object with two required keys:
Visibility is the only column attribute that this block changes. The name, type, and external code of an existing column cannot be changed |
|
delete |
Array of identifiers of the columns to delete. The identifiers can be obtained with the biconnector.table.get method |
All three parameters are optional and are processed in a single call in the order update, add, delete. A parameter that was not passed overwrites nothing, and a call that contains none of the three returns true and changes nothing.
Identifiers in update that do not belong to this table are skipped silently — no error is returned. Deletion, however, filters only by id, without checking that the column belongs to the specified table: before the call, verify the identifiers against the response of biconnector.table.get
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 10,
"add": [
{
"type": "int",
"name": "NAME",
"externalCode": "NAME"
},
{
"type": "int",
"name": "ID",
"externalCode": "ID"
}
],
"update": [
{
"id": 12,
"visible": false
},
{
"id": 13,
"visible": true
}
],
"delete": [
14,
15
],
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.table.fields.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.table.fields.update',
params: {
id: 10,
add: [
{
type: 'int',
name: 'NAME',
externalCode: 'NAME',
},
{
type: 'int',
name: 'ID',
externalCode: 'ID',
},
],
update: [
{
id: 12,
visible: false,
},
{
id: 13,
visible: true,
},
],
delete: [14, 15],
},
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('Table columns 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 updateTableColumns() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.table.fields.update',
params: {
id: 10,
add: [
{
type: 'int',
name: 'NAME',
externalCode: 'NAME',
},
{
type: 'int',
name: 'ID',
externalCode: 'ID',
},
],
update: [
{
id: 12,
visible: false,
},
{
id: 13,
visible: true,
},
],
delete: [14, 15],
},
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('Table columns updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateTableColumns)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
# b24pysdk has no ready-made wrapper for biconnector.table.*, so the method
# is called directly through bitrix_token.call_method()
response = bitrix_token.call_method(
api_method="biconnector.table.fields.update",
params={
"id": 10,
"add": [
{"type": "int", "name": "NAME", "externalCode": "NAME"},
{"type": "int", "name": "ID", "externalCode": "ID"},
],
"update": [
{"id": 12, "visible": False},
{"id": 13, "visible": True},
],
"delete": [14, 15],
},
)
result = 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.table.fields.update',
[
'id' => 10,
'add' => [
[
'type' => "int",
'name' => "NAME",
'externalCode' => "NAME"
],
[
'type' => "int",
'name' => "ID",
'externalCode' => "ID"
]
],
'update' => [
[
'id' => 12,
'visible' => false
],
[
'id' => 13,
'visible' => true
]
],
'delete' => [14, 15]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
$data = $result->data();
// 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 'Data: ' . print_r($data, true);
}
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating table columns: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.table.fields.update',
{
id: 10,
add: [
{
type: "int",
name: "NAME",
externalCode: "NAME"
},
{
type: "int",
name: "ID",
externalCode: "ID"
}
],
update: [
{
"id": 12,
"visible": false
},
{
"id": 13,
"visible": true
}
],
delete: [
14,
15
]
},
(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.table.fields.update',
[
'id' => 10,
'add' => [
[
'type' => 'int',
'name' => 'NAME',
'externalCode' => 'NAME'
],
[
'type' => 'int',
'name' => 'ID',
'externalCode' => 'ID'
]
],
'update' => [
[
'id' => 12,
'visible' => false
],
[
'id' => 13,
'visible' => true
]
],
'delete' => [14, 15]
]
);
// 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.table.fields.update", b24.Params{
"id": 10,
"add": []b24.Params{
{
"type": "int",
"name": "NAME",
"externalCode": "NAME",
},
{
"type": "int",
"name": "ID",
"externalCode": "ID",
},
},
"update": []b24.Params{
{
"id": 12,
"visible": false,
},
{
"id": 13,
"visible": true,
},
},
"delete": []int{14, 15},
})
if err != nil {
return fmt.Errorf("biconnector.table.fields.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.table.fields.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 |
Root element of the response. On a successful update it contains |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 200
{
"result": {
"error": {
"error": "VALIDATION_ID_NOT_PROVIDED",
"error_description": "ID is missing."
}
}
}
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, 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 |
|
|
Dataset was not found. |
The table does not exist or belongs to another application |
|
|
Error updating dataset. |
The changes could not be synchronized with BI Builder. The columns are already saved by then: the synchronization runs after the changes are committed, so the error arrives for edits that have already been applied and the method does not roll them back |
|
|
Duplicate values found in the "code" parameter: #LIST_CODES# |
Duplicates found in the |
|
|
Duplicate values found in the "name" parameter: #LIST_NAMES# |
Duplicates found in the |
|
|
Field "name" has to start with an uppercase Latin character. Possible entry includes uppercase Latin characters (A-Z), numbers (0-9) and underscores. |
Invalid format of the field name. The name must start with a letter and may contain only uppercase Latin letters |
|
|
Field "name" must not exceed 32 characters. |
The field name must not exceed 32 characters |
|
|
Invalid field type. |
Incorrect field type |
|
|
The following "externalCode" values already exist in the current fields: #LIST_CODES# |
Fields with this |
|
|
The following "name" values already exist in the current fields: #LIST_NAMES# |
Fields with this |
|
|
Field to be added must include the required parameters: "name", "externalCode" and "type". |
Field to be added must include |
|
|
Field to be updated must include the required parameters: "id" and "visible". |
Field to be updated must include |
|
|
ID to be deleted must be a positive integer. |
Invalid |
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 |