Create Table biconnector.table.add

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

Who can execute the method: A user who has both the "Access to BI Builder" and "Access to Analytics Hub" permissions

The biconnector.table.add method creates a new table linked to a data source.

The created table appears in BI Builder right away, in the Analytics hub > Tables section. The method does exactly what creating a table manually in the interface does: it saves the table, its fields, and the link to the source.

The method does not create a dataset for reports: datasets are separate BI Builder objects and are not created via the REST API. How a table differs from a dataset is described in the A Table and a Dataset Are Different Objects section

The method works only in the context of an application and only with 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
type

Description

fields*
object

An object containing data to create a new table. The object format:

{
            "field_1": "value_1",
            "field_2": "value_2",
            ...,
            "field_n": "value_n"
        }

field_n — field name
value_n — field value

Detailed description below

Parameter fields

Name `type`	Description
name* `string`	Table name. The name must start with a letter and may contain only lowercase Latin letters `a-z`, digits, and the `_` sign. The maximum name length is 230 characters
externalName* `string`	Name of the table in the external source, in the application. The maximum length is 512 characters
externalCode* `string`	Unique code of the table in the external source, used when selecting data. The maximum length is 512 characters
sourceId* `integer`	Source identifier, can be obtained with the biconnector.source.list or biconnector.source.add method. The source must belong to the connector of the current application, otherwise the method returns `SOURCE_NOT_FOUND`
description `string`	Table description
fields* `array`	Array of table columns (detailed description)

Element of the fields array

Each element of the fields array is an object with three required fields. Column visibility is not set on creation: all columns are created visible and can be hidden later with the biconnector.table.fields.update method.

Name `type`	Description
name* `string`	Column name. The name must start with a letter and may contain only uppercase Latin letters `A-Z`, digits, and the `_` sign. The maximum name length is 32 characters
externalCode* `string`	External code of the column — the name the application knows the column by. Bitrix24 passes exactly this code in the data request
type* `string`	Data type of the column. Allowed values: `int` — integer `string` — string `double` — float, dot separator `date` — date, format `Y-m-d` `datetime` — date with time, format `Y-m-d H:i:s` `money` — monetary value, retained as a number, the currency is not retained `timezone` — time zone identifier The value is case-sensitive: an uppercase `INT` causes the `VALIDATION_FIELD_INVALID_TYPE` error

Column names and external codes must not repeat within one request: on a repeated name the method returns the DUPLICATE_FIELDS error, and on a repeated externalCode — VALIDATION_DUPLICATE_FIELD_CODE.

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "fields": {
                "sourceId": 3,
                "name": "sales_orders",
                "externalName": "Sales orders",
                "externalCode": "sales_orders",
                "description": "Table description",
                "fields": [
                    { "type": "int", "name": "ID", "externalCode": "ID" },
                    { "type": "string", "name": "NAME", "externalCode": "NAME" },
                    { "type": "string", "name": "SURNAME", "externalCode": "SURNAME" },
                    { "type": "double", "name": "SCORE", "externalCode": "SCORE" },
                    { "type": "date", "name": "DATA", "externalCode": "DATA" },
                    { "type": "datetime", "name": "TIME", "externalCode": "TIME" }
                ]
            },
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/biconnector.table.add

// 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
          }
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type TableAddResult = {
          id: number
        }
        
        try {
          const response = await $b24.actions.v2.call.make<TableAddResult | BiconnectorError>({
            method: 'biconnector.table.add',
            params: {
              fields: {
                sourceId: 3,
                name: 'sales_orders',
                externalName: 'Sales orders',
                externalCode: 'sales_orders',
                description: 'Table description',
                fields: [
                  { type: 'int', name: 'ID', externalCode: 'ID' },
                  { type: 'string', name: 'NAME', externalCode: 'NAME' },
                  { type: 'string', name: 'SURNAME', externalCode: 'SURNAME' },
                  { type: 'double', name: 'SCORE', externalCode: 'SCORE' },
                  { type: 'date', name: 'DATA', externalCode: 'DATA' },
                  { type: 'datetime', name: 'TIME', externalCode: 'TIME' },
                ],
              },
            },
            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 ('error' in result) {
              console.error(result.error.error, result.error.error_description)
            } else {
              console.info('Created table id:', result.id)
            }
          }
        } 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 addTable() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'biconnector.table.add',
                params: {
                  fields: {
                    sourceId: 3,
                    name: 'sales_orders',
                    externalName: 'Sales orders',
                    externalCode: 'sales_orders',
                    description: 'Table description',
                    fields: [
                      { type: 'int', name: 'ID', externalCode: 'ID' },
                      { type: 'string', name: 'NAME', externalCode: 'NAME' },
                      { type: 'string', name: 'SURNAME', externalCode: 'SURNAME' },
                      { type: 'double', name: 'SCORE', externalCode: 'SCORE' },
                      { type: 'date', name: 'DATA', externalCode: 'DATA' },
                      { type: 'datetime', name: 'TIME', externalCode: 'TIME' },
                    ],
                  },
                },
                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('Created table id:', result.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addTable)
        </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.add",
                params={
                    "fields": {
                        "sourceId": 3,
                        "name": "sales_orders",
                        "externalName": "Sales orders",
                        "externalCode": "sales_orders",
                        "description": "Table description",
                        "fields": [
                            {"type": "int", "name": "ID", "externalCode": "ID"},
                            {"type": "string", "name": "NAME", "externalCode": "NAME"},
                            {"type": "string", "name": "SURNAME", "externalCode": "SURNAME"},
                            {"type": "double", "name": "SCORE", "externalCode": "SCORE"},
                            {"type": "date", "name": "DATA", "externalCode": "DATA"},
                            {"type": "datetime", "name": "TIME", "externalCode": "TIME"},
                        ],
                    },
                },
            )
            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.add',
                    [
                        'fields' => [
                            'sourceId'      => 3,
                            'name'          => 'sales_orders',
                            'externalName'  => 'Sales orders',
                            'externalCode'  => 'sales_orders',
                            'description'   => 'Table description',
                            'fields'        => [
                                ['type' => 'int', 'name' => 'ID', 'externalCode' => 'ID'],
                                ['type' => 'string', 'name' => 'NAME', 'externalCode' => 'NAME'],
                                ['type' => 'string', 'name' => 'SURNAME', 'externalCode' => 'SURNAME'],
                                ['type' => 'double', 'name' => 'SCORE', 'externalCode' => 'SCORE'],
                                ['type' => 'date', 'name' => 'DATA', 'externalCode' => 'DATA'],
                                ['type' => 'datetime', 'name' => 'TIME', 'externalCode' => 'TIME'],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($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 'Success: ' . print_r($data, true);
                }
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding table: ' . $e->getMessage();
        }

BX24.callMethod(
            'biconnector.table.add',
            {
                fields: {
                    "sourceId": 3,
                    "name": "sales_orders",
                    "externalName": "Sales orders",
                    "externalCode": "sales_orders",
                    "description": "Table description",
                    "fields": [
                        { "type": "int", "name": "ID", "externalCode": "ID" },
                        { "type": "string", "name": "NAME", "externalCode": "NAME" },
                        { "type": "string", "name": "SURNAME", "externalCode": "SURNAME" },
                        { "type": "double", "name": "SCORE", "externalCode": "SCORE" },
                        { "type": "date", "name": "DATA", "externalCode": "DATA" },
                        { "type": "datetime", "name": "TIME", "externalCode": "TIME" }
                    ]
                }
            },
            (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.add',
            [
                'fields' => [
                    'sourceId' => 3,
                    'name' => 'sales_orders',
                    'externalName' => 'Sales orders',
                    'externalCode' => 'sales_orders',
                    'description' => 'Table description',
                    'fields' => [
                        [ 'type' => 'int', 'name' => 'ID', 'externalCode' => 'ID' ],
                        [ 'type' => 'string', 'name' => 'NAME', 'externalCode' => 'NAME' ],
                        [ 'type' => 'string', 'name' => 'SURNAME', 'externalCode' => 'SURNAME' ],
                        [ 'type' => 'double', 'name' => 'SCORE', 'externalCode' => 'SCORE' ],
                        [ 'type' => 'date', 'name' => 'DATA', 'externalCode' => 'DATA' ],
                        [ 'type' => 'datetime', 'name' => 'TIME', 'externalCode' => 'TIME' ]
                    ]
                ]
            ]
        );
        
        // 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.add", b24.Params{
        	"fields": b24.Params{
        		"sourceId":     3,
        		"name":         "sales_orders",
        		"externalName": "Sales orders",
        		"externalCode": "sales_orders",
        		"description":  "Table description",
        		"fields": []b24.Params{
        			{
        				"type":         "int",
        				"name":         "ID",
        				"externalCode": "ID",
        			},
        			{
        				"type":         "string",
        				"name":         "NAME",
        				"externalCode": "NAME",
        			},
        			{
        				"type":         "string",
        				"name":         "SURNAME",
        				"externalCode": "SURNAME",
        			},
        			{
        				"type":         "double",
        				"name":         "SCORE",
        				"externalCode": "SCORE",
        			},
        			{
        				"type":         "date",
        				"name":         "DATA",
        				"externalCode": "DATA",
        			},
        			{
        				"type":         "datetime",
        				"name":         "TIME",
        				"externalCode": "TIME",
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("biconnector.table.add: %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.add: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
        }
        
        var item struct {
        	ID b24.ID `json:"id"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID)

Response Handling

HTTP status: 200

{
            "result": {
              "id": 10
            },
            "time": {
                "start": 1725013197.635808,
                "finish": 1725013198.580873,
                "duration": 0.9450650215148926,
                "processing": 0.6822988986968994,
                "date_start": "2024-08-30T12:19:57+02:00",
                "date_finish": "2024-08-30T12:19:58+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response (detailed description)
time `time`	Information about the request execution time

The result object

Name `type`	Description
id `integer`	Identifier of the created table. Use it in the biconnector.table.get, biconnector.table.update, and biconnector.table.fields.update methods

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

Code	Description	Value
`ACCESS_DENIED`	Access denied.	One of the two permissions is missing, or the method was called via a webhook or outside the application context
`VALIDATION_FIELDS_NOT_PROVIDED`	Fields not provided.	Fields were not passed in the request
`VALIDATION_UNKNOWN_PARAMETERS`	Unknown parameters: #LIST_OF_PARAMS#	Unknown parameters detected: list
`VALIDATION_REQUIRED_FIELD_MISSING`	Field "#TITLE#" is required.	Required field #TITLE# was not provided
`VALIDATION_READ_ONLY_FIELD`	Field "#TITLE#" is read only.	Field #TITLE# is read-only and cannot be modified
`VALIDATION_INVALID_FIELD_TYPE`	Field "#TITLE#" must be of type #TYPE#.	Field #TITLE# must be of type #TYPE#
`SOURCE_NOT_FOUND`	Source was not found.	The source does not exist or belongs to another application
`DATASET_ALREADY_EXIST`	Table with this name already exists.	The name is taken by a table that already exists in BI Builder itself
`NAME_EXISTS`	A table named "#NAME#" already exists.	The #NAME# name is already taken by another table in Bitrix24. The name is checked across the entire Bitrix24, not within the source
`FIELDS_EMPTY`	$fields is empty	An empty `fields` array was passed
`DUPLICATE_FIELDS`	Duplicate column names: #FIELD_NAMES#.	The `name` parameter of the fields contains repeats: the list
`VALIDATION_DATASET_NAME_INVALID`	Dataset name has to start with a lowercase Latin character. Possible entry includes lowercase Latin characters (a-z), numbers (0-9) and underscores.	Invalid format of the table name. The name must start with a letter and may contain only lowercase Latin letters `a-z`, digits, and the `_` sign
`VALIDATION_DATASET_NAME_TOO_LONG`	Dataset name must not exceed 230 characters.	The table name must not exceed 230 characters
`VALIDATION_DUPLICATE_FIELD_CODE`	Duplicate values found in the "code" parameter: #LIST_CODES#	Duplicates found in the `externalCode` parameter of the table fields
`VALIDATION_FIELD_MISSING_REQUIRED_PARAMETERS`	Field must include the required parameters: "name", "externalCode" and "type".	Field must include the parameters `name`, `externalCode`, and `type`
`VALIDATION_FIELD_NAME_INVALID_FORMAT`	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 `A-Z`, digits, and the `_` sign
`VALIDATION_FIELD_NAME_TOO_LONG`	Field "name" must not exceed 32 characters.	The field name must not exceed 32 characters
`VALIDATION_FIELD_INVALID_TYPE`	Invalid field type.	Invalid field type

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

Was the article helpful?

Overview of methods

Update table

Create Table biconnector.table.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Element of the fields arrayElement of the fields array

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

The result objectThe result object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning