Update Product or Variation Property catalog.productProperty.update

Scope: catalog

Who can execute the method: user with permission to view the catalog

The method catalog.productProperty.update modifies the fields of a product or variation property.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
catalog_product_property.id

Property identifier.

Property identifiers can be obtained using the catalog.productProperty.list method.

fields*
object

Set of fields to update the property (detailed description)

Fields Parameter

Required parameters are marked with *

Name `type`	Description
iblockId* `catalog_catalog.id`	Identifier of the trade catalog. Identifiers can be obtained using the catalog.catalog.list method.
name `string`	Property name
propertyType `string`	Base type of the property. Cannot be changed
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 property value
userType `string`	User-defined property type. Cannot be changed
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`	Multiple value indicator. 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 inputting multiple values
linkIblockId `catalog_catalog.id`	Identifier of the related information block. Available identifiers can be obtained using the catalog.catalog.list method.
withDescription `char`	Indicator of storing the value description. 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`	Field hint
userTypeSettings `object`	Settings for the user-defined type. Only scalar values and nested objects of scalar values are supported. If `userType` is specified but `userTypeSettings` is not, the settings are not validated by the method.

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 '{"id":115,"fields":{"iblockId":19,"name":"Size","propertyType":"L","isRequired":"Y","active":"Y"}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productProperty.update

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":115,"fields":{"iblockId":19,"name":"Size","propertyType":"L","isRequired":"Y","active":"Y"},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/catalog.productProperty.update

try {
            const response = await $b24.callMethod('catalog.productProperty.update', {
                id: 115,
                fields: {
                    iblockId: 19,
                    name: 'Size',
                    propertyType: 'L',
                    isRequired: 'Y',
                    active: 'Y'
                }
            });
        
            console.log(response.getData().result);
        }
        catch (error) {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productProperty.update',
                    [
                        'id' => 115,
                        'fields' => [
                            'iblockId' => 19,
                            'name' => 'Size',
                            'propertyType' => 'L',
                            'isRequired' => 'Y',
                            'active' => 'Y',
                        ]
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (\Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'catalog.productProperty.update',
            {
                id: 115,
                fields: {
                    iblockId: 19,
                    name: 'Size',
                    propertyType: 'L',
                    isRequired: 'Y',
                    active: 'Y'
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.productProperty.update',
            [
                'id' => 115,
                'fields' => [
                    'iblockId' => 19,
                    'name' => 'Size',
                    'propertyType' => 'L',
                    'isRequired' => 'Y',
                    'active' => 'Y',
                ]
            ]
        );
        
        print_r($result);

Response Handling

HTTP status: 200

{
            "result": {
                "productProperty": {
                    "active": "Y",
                    "code": null,
                    "colCount": 30,
                    "defaultValue": null,
                    "fileType": null,
                    "filtrable": "Y",
                    "hint": null,
                    "iblockId": 19,
                    "id": 115,
                    "name": "Size",
                    "isRequired": "Y",
                    "linkIblockId": null,
                    "listType": "L",
                    "multiple": "N",
                    "multipleCnt": null,
                    "propertyType": "L",
                    "rowCount": 1,
                    "searchable": "N",
                    "sort": 500,
                    "timestampX": "2026-03-19T20:46:43+02:00",
                    "userType": null,
                    "userTypeSettings": null,
                    "withDescription": null,
                    "xmlId": null
                }
            },
            "time": {
                "start": 1773946003,
                "finish": 1773946003.953583,
                "duration": 0.9535830020904541,
                "processing": 0,
                "date_start": "2026-03-19T21:46:43+02:00",
                "date_finish": "2026-03-19T21:46:43+02:00",
                "operating_reset_at": 1773946603,
                "operating": 0
            }
        }

Returned Data

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

Error Handling

HTTP status: 400

{
            "error": "0",
            "error_description": "Required fields: iblockId"
        }

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	The required parameter `iblockId` is not passed in `fields`
`400`	`0`	Access Denied	Insufficient rights to view the catalog
`400`	Empty value	productProperty does not exist	Property with the specified `id` not found
`400`	`0`	The specified property does not belong to a product catalog	The property does not belong to the 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 of `userTypeSettings` was provided
`400`	`0`	Property code cannot start with a digit	Invalid format of the `code` parameter
`400`	`0`	Invalid information block code	Invalid format of the `iblockId` parameter
`400`	`100`	Invalid value {`...`} to match with parameter {id}. Should be value of type int	Invalid data type for the `id` parameter value
`400`	`0`	Wrong format of field `...`	A parameter with a type that does not match the field format was provided
`400`	`0`	Error updating product property	Internal error while updating 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

Add Property

Get Property Field Values

Update Product or Variation Property catalog.productProperty.update

Method ParametersMethod Parameters

Fields ParameterFields Parameter

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