Set Products in Lead crm.lead.productrows.set

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

Who can execute the method: user with "edit" access permission for the lead

DEPRECATED

The development of this method has been halted. Please use crm.item.productrow.*.

The method crm.lead.productrows.set creates or updates the product rows of a lead. Existing rows that are not passed to the method will be removed from the lead.

To modify only a single row, use the methods crm.item.productrow.*.

Method Parameters

Required parameters are marked with *

Name
type

Description

id^*
integer

Lead identifier. Can be obtained using the method to retrieve the list of leads: crm.lead.list or when creating a lead: crm.lead.add

rows
object[]

Product rows

An array of objects in the following format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where

field_n — name of the product row field
value_n — value of this field

The list of available fields is described below

List of Available Fields for Product Rows

Name `type`	Description
PRODUCT_ID `integer`	Identifier of the product in the catalog. You can get the list of products using the method `catalog.product.list` `0` if not from the catalog Default - `0`
PRODUCT_NAME `string`	Name of the product row. If `PRODUCT_ID` is provided, the name will be taken from the product If both `PRODUCT_ID` and `PRODUCT_NAME` are not provided, then `PRODUCT_NAME` will be equal to `[{id}]`, where `{id}` is the identifier of the created product row
PRICE `double`	Final cost of the product per unit Default - `0.0`
PRICE_EXCLUSIVE `double`	Cost per unit considering discounts, excluding taxes
PRICE_NETTO `double`	Cost per unit excluding discounts and taxes
PRICE_BRUTTO `double`	Cost per unit excluding discounts but including taxes
QUANTITY `double`	Quantity of the product Default - `1.0`
DISCOUNT_TYPE_ID `integer`	Discount type Possible types: `1` - Absolute `2` - Percentage Default - `2`
DISCOUNT_RATE `double`	Discount value in percentage (if percentage discount type is used) Default - `0.0`
DISCOUNT_SUM `double`	Absolute discount value (if absolute discount type is used) Default - `0.0`
TAX_RATE `double`	Tax rate in percentage
TAX_INCLUDED `char`	Indicator of whether tax is included in the price Possible values: `Y` – tax included `N` – tax not included Default - `N`
MEASURE_CODE `catalog_measure.code`	Unit of measure code If `PRODUCT_ID` is provided, the default value will be taken from the product, otherwise `0`
MEASURE_NAME `string`	Text representation of the unit of measure (e.g., pcs, kg, m, l, etc.) If `PRODUCT_ID` is provided, the default value will be taken from the product, otherwise `""`
SORT `integer`	Sorting Default - `0`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":5,"rows":[{"PRODUCT_ID":456,"PRICE":1000,"QUANTITY":10,"DISCOUNT_TYPE_ID":1,"DISCOUNT_SUM":100,"TAX_RATE":13,"MEASURE_CODE":796,"MEASURE_NAME":"pcs","SORT":10},{"PRODUCT_NAME":"Product #2","PRICE":500,"QUANTITY":5,"DISCOUNT_TYPE_ID":2,"DISCOUNT_RATE":10,"TAX_RATE":10,"MEASURE_CODE":166,"MEASURE_NAME":"kg","SORT":20}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.productrows.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":5,"rows":[{"PRODUCT_ID":456,"PRICE":1000,"QUANTITY":10,"DISCOUNT_TYPE_ID":1,"DISCOUNT_SUM":100,"TAX_RATE":13,"MEASURE_CODE":796,"MEASURE_NAME":"pcs","SORT":10},{"PRODUCT_NAME":"Product #2","PRICE":500,"QUANTITY":5,"DISCOUNT_TYPE_ID":2,"DISCOUNT_RATE":10,"TAX_RATE":10,"MEASURE_CODE":166,"MEASURE_NAME":"kg","SORT":20}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.lead.productrows.set

// 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
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'crm.lead.productrows.set',
            params: {
              id: 5,
              rows: [
                {
                  PRODUCT_ID: 456,
                  PRICE: 1000,
                  QUANTITY: 10,
                  DISCOUNT_TYPE_ID: 1,
                  DISCOUNT_SUM: 100,
                  TAX_RATE: 13,
                  MEASURE_CODE: 796,
                  MEASURE_NAME: 'pcs',
                  SORT: 10,
                },
                {
                  PRODUCT_NAME: 'Product #2',
                  PRICE: 500,
                  QUANTITY: 5,
                  DISCOUNT_TYPE_ID: 2,
                  DISCOUNT_RATE: 10,
                  TAX_RATE: 10,
                  MEASURE_CODE: 166,
                  MEASURE_NAME: 'kg',
                  SORT: 20,
                },
              ],
            },
            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('Product rows set:', result)
          }
        } 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 setLeadProductRows() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.lead.productrows.set',
                params: {
                  id: 5,
                  rows: [
                    {
                      PRODUCT_ID: 456,
                      PRICE: 1000,
                      QUANTITY: 10,
                      DISCOUNT_TYPE_ID: 1,
                      DISCOUNT_SUM: 100,
                      TAX_RATE: 13,
                      MEASURE_CODE: 796,
                      MEASURE_NAME: 'pcs',
                      SORT: 10,
                    },
                    {
                      PRODUCT_NAME: 'Product #2',
                      PRICE: 500,
                      QUANTITY: 5,
                      DISCOUNT_TYPE_ID: 2,
                      DISCOUNT_RATE: 10,
                      TAX_RATE: 10,
                      MEASURE_CODE: 166,
                      MEASURE_NAME: 'kg',
                      SORT: 20,
                    },
                  ],
                },
                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('Product rows set:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', setLeadProductRows)
        </script>


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.lead.productrows.set(
                bitrix_id=1201,
                rows=[
                {
                "PRODUCT_ID": 456,
                "PRODUCT_NAME": "Enterprise CRM License",
                "PRICE": 1200.0,
                "QUANTITY": 12,
                "DISCOUNT_TYPE_ID": 1,
                "DISCOUNT_SUM": 150.0,
                "TAX_RATE": 20.0,
                "TAX_INCLUDED": "N",
                "MEASURE_CODE": 796,
                "MEASURE_NAME": "pcs",
                "SORT": 10,
                },
                {
                "PRODUCT_NAME": "Implementation Package",
                "PRICE": 5000.0,
                "QUANTITY": 1,
                "DISCOUNT_TYPE_ID": 2,
                "DISCOUNT_RATE": 10.0,
                "TAX_RATE": 20.0,
                "TAX_INCLUDED": "N",
                "MEASURE_CODE": 796,
                "MEASURE_NAME": "pcs",
                "SORT": 20,
                },
                ],
            ).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(
                    'crm.lead.productrows.set',
                    [
                        'id'   => 5,
                        'rows' => [
                            [
                                'PRODUCT_ID'       => 456,
                                'PRICE'           => 1000,
                                'QUANTITY'        => 10,
                                'DISCOUNT_TYPE_ID' => 1,
                                'DISCOUNT_SUM'    => 100,
                                'TAX_RATE'        => 13,
                                'MEASURE_CODE'    => 796,
                                'MEASURE_NAME'    => "pcs",
                                'SORT'            => 10,
                            ],
                            [
                                'PRODUCT_NAME'     => "Product #2",
                                'PRICE'           => 500,
                                'QUANTITY'        => 5,
                                'DISCOUNT_TYPE_ID' => 2,
                                'DISCOUNT_RATE'   => 10,
                                'TAX_RATE'        => 10,
                                'MEASURE_CODE'    => 166,
                                'MEASURE_NAME'    => "kg",
                                'SORT'            => 20,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting lead product rows: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.lead.productrows.set',
            {
                id: 5,
                rows: [
                    {
                        PRODUCT_ID: 456,
                        PRICE: 1000,
                        QUANTITY: 10,
                        DISCOUNT_TYPE_ID: 1,
                        DISCOUNT_SUM: 100,
                        TAX_RATE: 13,
                        MEASURE_CODE: 796,
                        MEASURE_NAME: "pcs",
                        SORT: 10,
                    },
                    {
                        PRODUCT_NAME: "Product #2",
                        PRICE: 500,
                        QUANTITY: 5,
                        DISCOUNT_TYPE_ID: 2,
                        DISCOUNT_RATE: 10,
                        TAX_RATE: 10,
                        MEASURE_CODE: 166,
                        MEASURE_NAME: "kg",
                        SORT: 20,
                    },
                ],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.lead.productrows.set',
            [
                'id' => 5,
                'rows' => [
                    [
                        'PRODUCT_ID' => 456,
                        'PRICE' => 1000,
                        'QUANTITY' => 10,
                        'DISCOUNT_TYPE_ID' => 1,
                        'DISCOUNT_SUM' => 100,
                        'TAX_RATE' => 13,
                        'MEASURE_CODE' => 796,
                        'MEASURE_NAME' => "pcs",
                        'SORT' => 10,
                    ],
                    [
                        'PRODUCT_NAME' => "Product #2",
                        'PRICE' => 500,
                        'QUANTITY' => 5,
                        'DISCOUNT_TYPE_ID' => 2,
                        'DISCOUNT_RATE' => 10,
                        'TAX_RATE' => 10,
                        'MEASURE_CODE' => 166,
                        'MEASURE_NAME' => "kg",
                        'SORT' => 20,
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.lead.productrows.set", b24.Params{
        	"id": 5,
        	"rows": []b24.Params{
        		{
        			"PRODUCT_ID":       456,
        			"PRICE":            1000,
        			"QUANTITY":         10,
        			"DISCOUNT_TYPE_ID": 1,
        			"DISCOUNT_SUM":     100,
        			"TAX_RATE":         13,
        			"MEASURE_CODE":     796,
        			"MEASURE_NAME":     "pcs",
        			"SORT":             10,
        		},
        		{
        			"PRODUCT_NAME":     "Product #2",
        			"PRICE":            500,
        			"QUANTITY":         5,
        			"DISCOUNT_TYPE_ID": 2,
        			"DISCOUNT_RATE":    10,
        			"TAX_RATE":         10,
        			"MEASURE_CODE":     166,
        			"MEASURE_NAME":     "kg",
        			"SORT":             20,
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.lead.productrows.set: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)

Response Handling

HTTP Status: 200

{
          "result": true,
          "time": {
            "start": 1772549200,
            "finish": 1772549200.281883,
            "duration": 0.28188300132751465,
            "processing": 0,
            "date_start": "2026-03-03T17:46:40+01:00",
            "date_finish": "2026-03-03T17:46:40+01:00",
            "operating_reset_at": 1772549800,
            "operating": 0.9811058044433594
          }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response, contains `true` in case of success
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
          "error": "ERROR_CORE",
          "error_description": "Discount Sum (DISCOUNT_SUM) is required if Percentage Discount Type (DISCOUNT_TYPE_ID) is defined and Discount Rate (DISCOUNT_RATE) is 100%<br>"
        }

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

Description	Value
The parameter id is invalid or not defined	An incorrect value was passed to the `id` parameter
The parameter rows must be array	A non-array value was passed to the `rows` parameter
Access denied	The user does not have permission to "edit" the lead
Not found	The lead with the provided `id` was not found
Discount Rate (`DISCOUNT_RATE`) is required if Percentage Discount Type (`DISCOUNT_TYPE_ID`) is defined	`DISCOUNT_TYPE_ID = 2` was passed without `DISCOUNT_RATE`
Discount Sum (`DISCOUNT_SUM`) is required if Percentage Discount Type (`DISCOUNT_TYPE_ID`) is defined and Discount Rate (`DISCOUNT_RATE`) is 100%	`DISCOUNT_RATE = 100` and `DISCOUNT_TYPE_ID = 2` were passed without `DISCOUNT_SUM`
Discount Sum (`DISCOUNT_SUM`) is required if Monetary Discount Type (`DISCOUNT_TYPE_ID`) is defined	`DISCOUNT_TYPE_ID = 1` was passed without `DISCOUNT_SUM`

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

Get Lead Product Rows crm.lead.productrows.get

Was the article helpful?

Get Lead Fields

Get Lead Products

Set Products in Lead crm.lead.productrows.set

Method ParametersMethod Parameters

List of Available Fields for Product RowsList of Available Fields for Product Rows

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