Update Product or Variation Property catalog.productProperty.update

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: 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 -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
        
// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type ProductPropertyUpdateResult = {
          productProperty: {
            active: 'Y' | 'N'
            code: string | null
            colCount: number
            defaultValue: string | null
            fileType: string | null
            filtrable: 'Y' | 'N'
            hint: string | null
            iblockId: number
            id: number
            isRequired: 'Y' | 'N'
            linkIblockId: number | null
            listType: string | null
            multiple: 'Y' | 'N'
            multipleCnt: number | null
            name: string
            propertyType: string
            rowCount: number
            searchable: 'Y' | 'N'
            sort: number
            timestampX: ISODate
            userType: string | null
            userTypeSettings: Record<string, unknown> | null
            withDescription: 'Y' | 'N' | null
            xmlId: string | null
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<ProductPropertyUpdateResult>({
            method: 'catalog.productProperty.update',
            params: {
              id: 115,
              fields: {
                iblockId: 19,
                name: 'Size',
                propertyType: 'L',
                isRequired: 'Y',
                active: 'Y',
              },
            },
            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(result.productProperty.id, result.productProperty.name, result.productProperty.active)
          }
        } 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 updateProductProperty() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.productProperty.update',
                params: {
                  id: 115,
                  fields: {
                    iblockId: 19,
                    name: 'Size',
                    propertyType: 'L',
                    isRequired: 'Y',
                    active: 'Y',
                  },
                },
                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(result.productProperty.id, result.productProperty.name, result.productProperty.active)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateProductProperty)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product_property.update(
                bitrix_id=115,
                fields={
                    "iblockId": 19,
                    "name": "Size",
                    "propertyType": "L",
                    "active": "Y",
                },
            ).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(
                    '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);
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "catalog.productProperty.update", b24.Params{
        	"id": 115,
        	"fields": b24.Params{
        		"iblockId":     19,
        		"name":         "Size",
        		"propertyType": "L",
        		"isRequired":   "Y",
        		"active":       "Y",
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.productProperty.update: %w", err)
        }
        
        // The method wraps the response in an object with the "productProperty" key.
        raw, ok := b24.Unwrap(res.Result, "productProperty")
        if !ok {
        	return fmt.Errorf("no productProperty key in the response")
        }
        
        var item struct {
        	Active    string `json:"active"`
        	ColCount  int    `json:"colCount"`
        	Filtrable string `json:"filtrable"`
        	IblockID  b24.ID `json:"iblockId"`
        	ID        b24.ID `json:"id"`
        	Name      string `json:"name"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Active, item.ColCount)
        

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

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