Add Product Property or Variation catalog.productProperty.add

Scope: catalog

Who can execute the method: user with permission to modify the product catalog

The method catalog.productProperty.add adds a property to a product or variation.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Set of fields for the new property (detailed description)

Parameter fields

Required parameters are marked with *

Name `type`	Description
iblockId* `catalog_catalog.id`	Identifier of the trade catalog. Existing identifiers can be obtained using the method catalog.catalog.list
name* `string`	Property name
propertyType* `string`	Basic type of the property. Allowed values: `N` — number `S` — string `L` — list `F` — file `E` — binding to elements `G` — binding to sections
active `char`	Activity status. Allowed values: `Y` — yes `N` — no
sort `integer`	Sort index
code `string`	Symbolic code of the property. The property code can consist of Latin letters, numbers, and underscores. The first character cannot be a digit
defaultValue `text`	Default value of the property
userType `string`	Custom type of the property. The value must correspond to the specified `propertyType`. Examples of values: `DateTime` — date and time `Money` — monetary value with currency `SKU` — binding to product variations `directory` — binding to a directory `employee` — binding to an employee `UserID` — binding to a user `EList` — selection of an item from a list `EAutocomplete` — binding to elements with auto-search `SectionAuto` — binding to sections with auto-search `HTML` — value in HTML format `map_google` — coordinates and address on Google Maps `DiskFile` — binding to a file from Bitrix24.Drive `ECrm` — binding to CRM elements `BoolEnum` — checkbox based on a list, use this value with `propertyType = L`
rowCount `integer`	Number of input field rows
colCount `integer`	Number of input field columns
listType `char`	Appearance of the list. Allowed values: `L` — dropdown list `C` — set of checkboxes
multiple `char`	Indicator of multiple values. Allowed values: `Y` — yes `N` — no
xmlId `string`	External identifier of the property
fileType `string`	List of file extensions for property type `F`
multipleCnt `integer`	Number of fields for entering multiple values
linkIblockId `catalog_catalog.id`	Identifier of the related information block. Available identifiers can be obtained using the method catalog.catalog.list
withDescription `char`	Indicator of storing the description of the value. Allowed values: `Y` — yes `N` — no
searchable `char`	Indicator of participation in search. Allowed values: `Y` — yes `N` — no
filtrable `char`	Indicator of participation in filtering. Allowed values: `Y` — yes `N` — no
isRequired `char`	Indicator of required value. Allowed values: `Y` — yes `N` — no
hint `string`	Hint for the field
userTypeSettings `object`	Settings for the custom type. Only scalar values and nested objects from scalar values are supported

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"fields":{"iblockId":19,"name":"Category","code":"CATEGORY","propertyType":"S","userType":"directory","multiple":"N","isRequired":"N","active":"Y","sort":100,"userTypeSettings":{"tableName":"b_hlbd_categories"}}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productProperty.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"fields":{"iblockId":19,"name":"Category","code":"CATEGORY","propertyType":"S","userType":"directory","multiple":"N","isRequired":"N","active":"Y","sort":100,"userTypeSettings":{"tableName":"b_hlbd_categories"}},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/catalog.productProperty.add

try {
            const response = await $b24.callMethod('catalog.productProperty.add', {
                fields: {
                    iblockId: 19,
                    name: 'Category',
                    code: 'CATEGORY',
                    propertyType: 'S',
                    userType: 'directory',
                    multiple: 'N',
                    isRequired: 'N',
                    active: 'Y',
                    sort: 100,
                    userTypeSettings: {
                        tableName: 'b_hlbd_categories', // existing directory in Bitrix24
                    }
                }
            });
        
            console.log(response.getData().result);
        }
        catch (error) {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productProperty.add',
                    [
                        'fields' => [
                            'iblockId' => 19,
                            'name' => 'Category',
                            'code' => 'CATEGORY',
                            'propertyType' => 'S',
                            'userType' => 'directory',
                            'multiple' => 'N',
                            'isRequired' => 'N',
                            'active' => 'Y',
                            'sort' => 100,
                            'userTypeSettings' => [
                                'tableName' => 'b_hlbd_categories', // existing directory in Bitrix24
                            ],
                        ],
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (\Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'catalog.productProperty.add',
            {
                fields: {
                    iblockId: 19,
                    name: 'Category',
                    code: 'CATEGORY',
                    propertyType: 'S',
                    userType: 'directory',
                    multiple: 'N',
                    isRequired: 'N',
                    active: 'Y',
                    sort: 100,
                    userTypeSettings: {
                        tableName: 'b_hlbd_categories', // existing directory in Bitrix24
                    }
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.productProperty.add',
            [
                'fields' => [
                    'iblockId' => 19,
                    'name' => 'Category',
                    'code' => 'CATEGORY',
                    'propertyType' => 'S',
                    'userType' => 'directory',
                    'multiple' => 'N',
                    'isRequired' => 'N',
                    'active' => 'Y',
                    'sort' => 100,
                    'userTypeSettings' => [
                        'tableName' => 'b_hlbd_categories', // existing directory in Bitrix24
                    ],
                ]
            ]
        );
        
        print_r($result);

Response Handling

HTTP status: 200

{
            "result": {
                "productProperty": {
                    "active": "Y",
                    "code": "CATEGORY",
                    "colCount": 30,
                    "defaultValue": null,
                    "fileType": null,
                    "filtrable": "N",
                    "hint": null,
                    "iblockId": 19,
                    "id": 659,
                    "isRequired": "N",
                    "linkIblockId": null,
                    "listType": "L",
                    "multiple": "N",
                    "multipleCnt": null,
                    "name": "Category",
                    "propertyType": "S",
                    "rowCount": 1,
                    "searchable": "N",
                    "sort": 100,
                    "timestampX": "2026-03-19T15:46:23+02:00",
                    "userType": "directory",
                    "userTypeSettings": {
                        "group": "N",
                        "multiple": "N",
                        "size": 1,
                        "tableName": "b_hlbd_categories",
                        "width": 0
                    },
                    "withDescription": null,
                    "xmlId": null
                }
            },
            "time": {
                "start": 1773927983,
                "finish": 1773927983.409049,
                "duration": 0.40904903411865234,
                "processing": 0,
                "date_start": "2026-03-19T16:46:23+02:00",
                "date_finish": "2026-03-19T16:46:23+02:00",
                "operating_reset_at": 1773928583,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root object of the response
productProperty `catalog_product_property`	Object with information about the added property
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "0",
            "error_description": "Invalid property type specified"
        }

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
`400`	`0`	Required fields: iblockId, name, propertyType	Required fields not provided in `fields`
`400`	`0`	Access Denied	No permission to modify the information block
`400`	`0`	The specified iblock is not a product catalog	The provided `iblockId` is not a trade catalog
`400`	`0`	Invalid property type specified	An invalid combination of `propertyType` and `userType` was provided
`400`	`0`	Invalid custom property type settings specified	An invalid format for `userTypeSettings` was provided
`400`	`0`	Property code cannot start with a digit	Invalid format for the `code` parameter
`400`	`0`	Wrong format of field `...`	A parameter with a type that does not match the field format was provided
`400`	`0`	Error adding property	Internal error while creating the property

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

Overview of Methods

Update Property

Add Product Property or Variation catalog.productProperty.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

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