Create a Field for Universal List lists.field.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:
listsWho can execute the method: a user with "Full access" permission for the required list
The method lists.field.add creates a list field.
You can find the available field types for the universal list using the method lists.field.type.get
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
IBLOCK_TYPE_ID* |
Information block type ID. Standard types:
In the on-premise version, you can also specify the ID of any existing custom information block type. The identifier can be obtained using the method lists.get.iblock.type.id |
|
IBLOCK_ID* |
Identifier of the information block. The identifier can be obtained using the method lists.get |
|
IBLOCK_CODE* |
Symbolic code of the information block. The code can be obtained using the method lists.get At least one of the parameters: |
|
FIELDS* |
Array of parameters. |
Parameter FIELDS
Required parameters are marked with *
|
Name |
Description |
|
NAME* |
Field name |
|
TYPE* |
Field type. Once created, the field type cannot be changed. Custom fields:
System fields:
Values in the fields Creation date, Modification date, Created by, and Modified by are filled automatically. System fields are not added to the new list by default. To display them in the list interface, they must also be explicitly created. |
|
IS_REQUIRED |
Field required flag. Possible values:
Default — |
|
MULTIPLE |
Field multiplicity flag. Possible values:
Default — System fields cannot be multiple |
|
SORT |
Sorting |
|
DEFAULT_VALUE |
Default value. If the |
|
LIST |
Values for the List type field. An array in the format After creating the field, the system will replace temporary identifiers with permanent ones |
|
LIST_TEXT_VALUES |
An alternative way to specify values for the List type field. A string where values are separated by the newline character When creating a List type field, you can use either |
|
LIST_DEF |
Default value for the List type field. The array accepts a temporary identifier from |
|
CODE |
Symbolic code of the field. Required for custom fields. Not used for system fields |
|
SETTINGS |
Display and behavior settings. Supported values:
To enable a setting, use Default: |
|
USER_TYPE_SETTINGS |
Array of settings for custom fields. The structure depends on the field type:
If not passed — the system will set default values as specified in the array examples |
|
ROW_COUNT |
Height of the field. Default — |
|
COL_COUNT |
Width of the field. Default — |
|
LINK_IBLOCK_ID |
Identifier of the related list. Required for types Binding to sections, Binding to elements, and Binding to elements as a list |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":"123","FIELDS":{"NAME":"Project","IS_REQUIRED":"Y","MULTIPLE":"N","TYPE":"L","SORT":"10","CODE":"PROJECT","LIST":{"10":{"VALUE":"Planning","SORT":10,"DEF":"Y"},"20":{"VALUE":"In Development","SORT":20,"DEF":"N"}},"LIST_TEXT_VALUES":"Testing\nCompleted\nDeferred","SETTINGS":{"SHOW_ADD_FORM":"Y","SHOW_EDIT_FORM":"Y","ADD_READ_ONLY_FIELD":"N","EDIT_READ_ONLY_FIELD":"N","SHOW_FIELD_PREVIEW":"N"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.field.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":"123","FIELDS":{"NAME":"Project","IS_REQUIRED":"Y","MULTIPLE":"N","TYPE":"L","SORT":"10","CODE":"PROJECT","LIST":{"10":{"VALUE":"Planning","SORT":10,"DEF":"Y"},"20":{"VALUE":"In Development","SORT":20,"DEF":"N"}},"LIST_TEXT_VALUES":"Testing\nCompleted\nDeferred","SETTINGS":{"SHOW_ADD_FORM":"Y","SHOW_EDIT_FORM":"Y","ADD_READ_ONLY_FIELD":"N","EDIT_READ_ONLY_FIELD":"N","SHOW_FIELD_PREVIEW":"N"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/lists.field.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
try {
const response = await $b24.actions.v2.call.make<string>({
method: 'lists.field.add',
params: {
IBLOCK_TYPE_ID: 'lists',
IBLOCK_ID: '123',
FIELDS: {
NAME: 'Project',
IS_REQUIRED: 'Y',
MULTIPLE: 'N',
TYPE: 'L',
SORT: '10',
CODE: 'PROJECT',
LIST: {
'10': { VALUE: 'Planning', SORT: 10, DEF: 'Y' },
'20': { VALUE: 'In progress', SORT: 20, DEF: 'N' },
},
LIST_TEXT_VALUES: 'Testing\nCompleted\nPostponed',
SETTINGS: {
SHOW_ADD_FORM: 'Y',
SHOW_EDIT_FORM: 'Y',
ADD_READ_ONLY_FIELD: 'N',
EDIT_READ_ONLY_FIELD: 'N',
SHOW_FIELD_PREVIEW: 'N',
},
},
},
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('Created field ID:', 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 addListField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'lists.field.add',
params: {
IBLOCK_TYPE_ID: 'lists',
IBLOCK_ID: '123',
FIELDS: {
NAME: 'Project',
IS_REQUIRED: 'Y',
MULTIPLE: 'N',
TYPE: 'L',
SORT: '10',
CODE: 'PROJECT',
LIST: {
'10': { VALUE: 'Planning', SORT: 10, DEF: 'Y' },
'20': { VALUE: 'In progress', SORT: 20, DEF: 'N' },
},
LIST_TEXT_VALUES: 'Testing\nCompleted\nPostponed',
SETTINGS: {
SHOW_ADD_FORM: 'Y',
SHOW_EDIT_FORM: 'Y',
ADD_READ_ONLY_FIELD: 'N',
EDIT_READ_ONLY_FIELD: 'N',
SHOW_FIELD_PREVIEW: 'N',
},
},
},
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('Created field ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addListField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"NAME": "Project",
"IS_REQUIRED": "Y",
"MULTIPLE": "N",
"TYPE": "L",
"SORT": "10",
"CODE": "PROJECT",
"LIST": {
"10": {
"VALUE": "Planning",
"SORT": 10,
"DEF": "Y",
},
"20": {
"VALUE": "In development",
"SORT": 20,
"DEF": "N",
},
},
"LIST_TEXT_VALUES": "Testing\nCompleted\nPostponed",
"SETTINGS": {
"SHOW_ADD_FORM": "Y",
"SHOW_EDIT_FORM": "Y",
"ADD_READ_ONLY_FIELD": "N",
"EDIT_READ_ONLY_FIELD": "N",
"SHOW_FIELD_PREVIEW": "N",
},
}
try:
bitrix_response = client.lists.field.add(
iblock_type_id="lists",
iblock_id=123,
fields=fields,
).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}")
try {
$response = $b24Service
->core
->call(
'lists.field.add',
[
'IBLOCK_TYPE_ID' => 'lists',
'IBLOCK_ID' => '123',
'FIELDS' => [
'NAME' => 'Project',
'IS_REQUIRED' => 'Y',
'MULTIPLE' => 'N',
'TYPE' => 'L',
'SORT' => '10',
'CODE' => 'PROJECT',
'LIST' => [
'10' => ['VALUE' => 'Planning', 'SORT' => 10, 'DEF' => 'Y'],
'20' => ['VALUE' => 'In Development', 'SORT' => 20, 'DEF' => 'N']
],
'LIST_TEXT_VALUES' => 'Testing\nCompleted\nDeferred',
'SETTINGS' => [
'SHOW_ADD_FORM' => 'Y',
'SHOW_EDIT_FORM' => 'Y',
'ADD_READ_ONLY_FIELD' => 'N',
'EDIT_READ_ONLY_FIELD' => 'N',
'SHOW_FIELD_PREVIEW' => 'N'
]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding field: ' . $e->getMessage();
}
BX24.callMethod(
'lists.field.add',
{
'IBLOCK_TYPE_ID': 'lists',
'IBLOCK_ID': '123',
'FIELDS': {
'NAME': 'Project',
'IS_REQUIRED': 'Y',
'MULTIPLE': 'N',
'TYPE': 'L',
'SORT': '10',
'CODE': 'PROJECT',
'LIST': {
'10': { 'VALUE': 'Planning', 'SORT': 10, 'DEF': 'Y' },
'20': { 'VALUE': 'In Development', 'SORT': 20, 'DEF': 'N' }
},
'LIST_TEXT_VALUES': 'Testing\nCompleted\nDeferred',
'SETTINGS': {
'SHOW_ADD_FORM': 'Y',
'SHOW_EDIT_FORM': 'Y',
'ADD_READ_ONLY_FIELD': 'N',
'EDIT_READ_ONLY_FIELD': 'N',
'SHOW_FIELD_PREVIEW': 'N'
}
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
// The final list will contain 5 options:
// 1. Planning (default), 2. In Development,
// 3. Testing, 4. Completed, 5. Deferred
}
}
);
require_once('crest.php');
$result = CRest::call(
'lists.field.add',
[
'IBLOCK_TYPE_ID' => 'lists',
'IBLOCK_ID' => '123',
'FIELDS' => [
'NAME' => 'Project',
'IS_REQUIRED' => 'Y',
'MULTIPLE' => 'N',
'TYPE' => 'L',
'SORT' => '10',
'CODE' => 'PROJECT',
'LIST' => [
'10' => ['VALUE' => 'Planning', 'SORT' => 10, 'DEF' => 'Y'],
'20' => ['VALUE' => 'In Development', 'SORT' => 20, 'DEF' => 'N']
],
'LIST_TEXT_VALUES' => 'Testing\nCompleted\nDeferred',
'SETTINGS' => [
'SHOW_ADD_FORM' => 'Y',
'SHOW_EDIT_FORM' => 'Y',
'ADD_READ_ONLY_FIELD' => 'N',
'EDIT_READ_ONLY_FIELD' => 'N',
'SHOW_FIELD_PREVIEW' => 'N'
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "lists.field.add", b24.Params{
"IBLOCK_TYPE_ID": "lists",
"IBLOCK_ID": "123",
"FIELDS": b24.Params{
"NAME": "Project",
"IS_REQUIRED": "Y",
"MULTIPLE": "N",
"TYPE": "L",
"SORT": "10",
"CODE": "PROJECT",
"LIST": b24.Params{
"10": b24.Params{
"VALUE": "Planning",
"SORT": 10,
"DEF": "Y",
},
"20": b24.Params{
"VALUE": "In Development",
"SORT": 20,
"DEF": "N",
},
},
"LIST_TEXT_VALUES": "Testing\nCompleted\nDeferred",
"SETTINGS": b24.Params{
"SHOW_ADD_FORM": "Y",
"SHOW_EDIT_FORM": "Y",
"ADD_READ_ONLY_FIELD": "N",
"EDIT_READ_ONLY_FIELD": "N",
"SHOW_FIELD_PREVIEW": "N",
},
},
})
if err != nil {
return fmt.Errorf("lists.field.add: %w", err)
}
var value string
if err := json.Unmarshal(res.Result, &value); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("result:", value)
Response Handling
HTTP status: 200
{
"result": "PROPERTY_1151",
"time": {
"start": 1765317940,
"finish": 1765317940.172892,
"duration": 0.17289209365844727,
"processing": 0,
"date_start": "2025-12-09T14:05:40+01:00",
"date_finish": "2025-12-09T14:05:40+01:00",
"operating_reset_at": 1765318540,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the created field with the prefix If a system field is created, its symbolic code is returned |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":"ERROR_SAVE_FIELD",
"error_description":"Please fill the code fields"
}
|
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 |
|
|
Required parameter |
Required parameter not passed |
|
|
Iblock not found |
Information block not found |
|
|
Error saving the field |
General error during the call |
|
|
Property already exists |
|
|
|
Please fill the code fields |
|
|
|
The default value of the field '...' is required |
The |
|
|
Incorrect lists specified for '...' property |
Error in one of the parameters inside |
|
|
Access denied |
Insufficient rights to add the field |
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 |