Add Product Property or Variation Parameter catalog.productPropertyFeature.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:
catalogWho can execute the method: a user with the "View product catalog" permission and the right to modify the information block property.
The method catalog.productPropertyFeature.add adds a parameter to a product or variation property.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Set of fields for the new property parameter (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
propertyId* |
Identifier of the product or variation property. Property identifiers can be obtained using the catalog.productProperty.list method. |
|
moduleId* |
Identifier of the module to which the property parameter belongs. The module identifier can be obtained using the catalog.productPropertyFeature.getAvailableFeaturesByProperty method. |
|
featureId* |
Code of the property parameter. The parameter code can be obtained using the catalog.productPropertyFeature.getAvailableFeaturesByProperty method. |
|
isEnabled* |
Indicator of the parameter's activity. Acceptable values:
|
Before adding, check for an existing entry using the catalog.productPropertyFeature.list method with a filter by propertyId, moduleId, and featureId. If the entry already exists, the method will return an error of the form Duplicate entry ... for key ....
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"propertyId":901,"moduleId":"iblock","featureId":"LIST_PAGE_SHOW","isEnabled":"Y"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productPropertyFeature.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"propertyId":901,"moduleId":"iblock","featureId":"LIST_PAGE_SHOW","isEnabled":"Y"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.productPropertyFeature.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type AddProductPropertyFeatureResult = {
productPropertyFeature: {
featureId: string
id: number
isEnabled: string
moduleId: string
propertyId: number
}
}
try {
const response = await $b24.actions.v2.call.make<AddProductPropertyFeatureResult>({
method: 'catalog.productPropertyFeature.add',
params: {
fields: {
propertyId: 901,
moduleId: 'iblock',
featureId: 'LIST_PAGE_SHOW',
isEnabled: '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.productPropertyFeature)
}
} 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 addProductPropertyFeature() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.productPropertyFeature.add',
params: {
fields: {
propertyId: 901,
moduleId: 'iblock',
featureId: 'LIST_PAGE_SHOW',
isEnabled: '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.productPropertyFeature)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addProductPropertyFeature)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product_property_feature.add(
fields={
"propertyId": 901,
"moduleId": "iblock",
"featureId": "LIST_PAGE_SHOW",
"isEnabled": "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.productPropertyFeature.add',
[
'fields' => [
'propertyId' => 901,
'moduleId' => 'iblock',
'featureId' => 'LIST_PAGE_SHOW',
'isEnabled' => 'Y',
],
]
);
print_r($response->getResponseData()->getResult());
} catch (\Throwable $exception) {
echo $exception->getMessage();
}
BX24.callMethod(
'catalog.productPropertyFeature.add',
{
fields: {
propertyId: 901,
moduleId: 'iblock',
featureId: 'LIST_PAGE_SHOW',
isEnabled: 'Y',
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.productPropertyFeature.add',
[
'fields' => [
'propertyId' => 901,
'moduleId' => 'iblock',
'featureId' => 'LIST_PAGE_SHOW',
'isEnabled' => 'Y',
]
]
);
print_r($result);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.productPropertyFeature.add", b24.Params{
"fields": b24.Params{
"propertyId": 901,
"moduleId": "iblock",
"featureId": "LIST_PAGE_SHOW",
"isEnabled": "Y",
},
})
if err != nil {
return fmt.Errorf("catalog.productPropertyFeature.add: %w", err)
}
// The method wraps the response in an object with the "productPropertyFeature" key.
raw, ok := b24.Unwrap(res.Result, "productPropertyFeature")
if !ok {
return fmt.Errorf("no productPropertyFeature key in the response")
}
var item struct {
FeatureID string `json:"featureId"`
ID b24.ID `json:"id"`
IsEnabled string `json:"isEnabled"`
ModuleID string `json:"moduleId"`
PropertyID b24.ID `json:"propertyId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.FeatureID, item.ID)
Response Handling
HTTP Status: 200
{
"result": {
"productPropertyFeature": {
"featureId": "LIST_PAGE_SHOW",
"id": 101,
"isEnabled": "Y",
"moduleId": "iblock",
"propertyId": 901
}
},
"time": {
"start": 1774013002,
"finish": 1774013002.429777,
"duration": 0.4297769069671631,
"processing": 0,
"date_start": "2026-03-20T16:23:22+01:00",
"date_finish": "2026-03-20T16:23:22+01:00",
"operating_reset_at": 1774013602,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root object of the response |
|
productPropertyFeature |
Object of the added property parameter |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "0",
"error_description": "Required fields: moduleId, featureId, isEnabled"
}
|
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 |
|
|
Access Denied |
Insufficient permissions to modify the information block property |
|
|
productPropertyFeature does not exist. |
Property with the provided |
|
|
Required fields: moduleId, featureId, isEnabled |
Required fields |
|
|
Invalid property parameter set |
Incorrect set of |
|
|
Mysql query error: (1062) Duplicate entry '...' for key 'b_iblock_property_feature.ix_iblock_property_feature' |
Entry with this combination of |
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 |
Continue Learning
- Update Product Property or Variation Parameter catalog.productPropertyFeature.update
- Get Product Property Feature Parameter or Variations catalog.productPropertyFeature.get
- Get a List of Product Property Feature Parameters or Variations catalog.productPropertyFeature.list
- Get Available Product Property Features or Variations catalog.productPropertyFeature.getAvailableFeaturesByProperty
- Get Fields of Product Property Features or Variations catalog.productPropertyFeature.getFields