Add Value to List Property catalog.productPropertyEnum.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: catalog

Who can execute the method: a user with the "View product catalog" permission and the right to modify the information block property.

The method catalog.productPropertyEnum.add adds a value to a list property.

Method Parameters

Required parameters are marked with *

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

Parameter fields

Required parameters are marked with *

Name `type`	Description
propertyId* `catalog_product_property.id`	Identifier of the product property or variation. Property identifiers can be obtained using the catalog.productProperty.list method.
value* `string`	Value of the list item.
xmlId* `string`	External identifier of the list value. Must be unique within the property.
def `char`	Indicator of the default value. Acceptable values: `Y` — default `N` — not default.
sort `integer`	Sort index.

The method only adds values for properties of type L (list). If a propertyId of a different type is provided, the method will return an error Only list properties 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":{"propertyId":431,"value":"Medium","xmlId":"M","def":"Y","sort":100}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productPropertyEnum.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"fields":{"propertyId":431,"value":"Medium","xmlId":"M","def":"Y","sort":100},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/catalog.productPropertyEnum.add

try {
            const response = await $b24.callMethod('catalog.productPropertyEnum.add', {
                fields: {
                    propertyId: 431,
                    value: 'Medium',
                    xmlId: 'M',
                    def: 'Y',
                    sort: 100,
                }
            });
        
            console.log(response.getData().result);
        } catch (error) {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productPropertyEnum.add',
                    [
                        'fields' => [
                            'propertyId' => 431,
                            'value' => 'Medium',
                            'xmlId' => 'M',
                            'def' => 'Y',
                            'sort' => 100,
                        ],
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (\Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'catalog.productPropertyEnum.add',
            {
                fields: {
                    propertyId: 431,
                    value: 'Medium',
                    xmlId: 'M',
                    def: 'Y',
                    sort: 100,
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.productPropertyEnum.add',
            [
                'fields' => [
                    'propertyId' => 431,
                    'value' => 'Medium',
                    'xmlId' => 'M',
                    'def' => 'Y',
                    'sort' => 100,
                ]
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "productPropertyEnum": {
                "def": "Y",
                "id": 1739,
                "propertyId": 431,
                "sort": 100,
                "value": "Medium",
                "xmlId": "M"
                }
            },
            "time": {
                "start": 1774279799,
                "finish": 1774279799.330864,
                "duration": 0.33086395263671875,
                "processing": 0,
                "date_start": "2026-03-23T18:29:59+02:00",
                "date_finish": "2026-03-23T18:29:59+02:00",
                "operating_reset_at": 1774280399,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root object of the response.
productPropertyEnum `catalog_product_property_enum`	Object of the added list property value.
time `time`	Information about the request execution time.

Error Handling

HTTP Status: 400

{
            "error": "BX_INVALID_VALUE",
            "error_description": "A record with the External code value equal to ... already exists in the database."
        }

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

Code	Description	Value
`0`	Access Denied	Insufficient rights to modify the information block property.
`0`	productPropertyEnum does not exist.	The property with the provided `propertyId` was not found or does not belong to the trade catalog.
`0`	Only list properties are supported	A property of a type other than `List` was provided.
`0`	Required fields: xmlId	The required field `xmlId` was not provided.
`0`	A value with xmlId '...' already exists.	A value with this `xmlId` already exists within the property.
`BX_INVALID_VALUE`	A record with the value "External code" equal to "..." already exists in the database.	Localized duplicate error for `xmlId`.
`0`	Internal error adding enumeration value. Try adding again.	Internal error while adding the list value.

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Overview of Methods

Update List Property Values

Add Value to List Property catalog.productPropertyEnum.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