## Set lead products

`PUT /v1/leads/:id/products`

Sets the lead product rows. Replaces the current list as a whole — pass all the rows you need.

> **Field names are validated.** A field name that is not in the writable set is not dropped silently: the request is rejected with `400 INVALID_PARAMS` and the error text lists the writable names. Read-only fields that appear in product-row responses — `priceAccount`, `ownerId`, `storeId` and others — are accepted and ignored, so an object read via `GET` can be sent back as is.

> **Row identifiers do not carry over.** A row whose fields are unchanged keeps its `id`. A modified one comes back with a new `id` even when the previous identifier is sent in the body. To edit a row and keep its `id`, use [`PATCH /v1/leads/:id/products/:rowId`](/docs/entities/leads/products-update).

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Lead ID. List: [`GET /v1/leads`](/docs/entities/leads/list) |

## Request fields (body)

| Field | Type | Required | Description |
|------|-----|:-----:|---------|
| `items` | array | yes | Array of product rows. An empty array deletes every row of the lead |
| `items[].productId` | number | no | Catalog product ID. Catalog: [`GET /v1/products`](/docs/entities/products/list). With neither `productId` nor `productName`, the row is created with no product and an empty name |
| `items[].productName` | string | no | Row name — for a free-text row with no catalog product |
| `items[].price` | number | no | Unit price. Without it the row is created with a zero price |
| `items[].quantity` | number | no | Quantity. Without it the row is created with a quantity of `1` |
| `items[].discountTypeId` | number | no | How the discount is set: `1` — as an amount in `discount`, `2` — as a percentage in `discountRate`. Defaults to `2` |
| `items[].discount` | number | no | Discount amount. Applied only when `discountTypeId` is `1` |
| `items[].discountRate` | number | no | Discount percentage. Applied only when `items[].discountTypeId` is `2` |
| `items[].taxRate` | number | no | Tax rate (%) |
| `items[].taxIncluded` | boolean | no | Tax included in the price |

## Examples

### curl — personal key

```bash
curl -X PUT "https://vibecode.bitrix24.com/v1/leads/1001333/products" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "productId": 6967, "price": 25000, "quantity": 2 },
      { "productId": 6969, "price": 5000, "quantity": 1, "discountTypeId": 1, "discount": 500 }
    ]
  }'
```

### curl — OAuth application

```bash
curl -X PUT "https://vibecode.bitrix24.com/v1/leads/1001333/products" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "productId": 6967, "price": 25000, "quantity": 2 },
      { "productId": 6969, "price": 5000, "quantity": 1, "discountTypeId": 1, "discount": 500 }
    ]
  }'
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/leads/1001333/products', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { productId: 6967, price: 25000, quantity: 2 },
      { productId: 6969, price: 5000, quantity: 1, discountTypeId: 1, discount: 500 },
    ],
  }),
})

const { success, data } = await res.json()
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/leads/1001333/products', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { productId: 6967, price: 25000, quantity: 2 },
      { productId: 6969, price: 5000, quantity: 1, discountTypeId: 1, discount: 500 },
    ],
  }),
})

const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | All rows of the lead after the replacement, each in full. Row fields — see [Product fields](/docs/entities/leads/products-fields) |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 2373,
      "ownerId": 1001333,
      "ownerType": "L",
      "productId": 6967,
      "productName": "Parent product",
      "price": 25000,
      "priceAccount": 25000,
      "priceExclusive": 25000,
      "priceNetto": 25000,
      "priceBrutto": 25000,
      "quantity": 2,
      "discountTypeId": 2,
      "discountRate": 0,
      "discount": 0,
      "taxRate": null,
      "taxIncluded": false,
      "customized": "Y",
      "measureCode": 796,
      "measureName": "pcs",
      "sort": 0,
      "xmlId": "",
      "type": 3,
      "storeId": null
    },
    {
      "id": 2375,
      "ownerId": 1001333,
      "ownerType": "L",
      "productId": 6969,
      "productName": "Service",
      "price": 5000,
      "priceAccount": 5000,
      "priceExclusive": 5000,
      "priceNetto": 5500,
      "priceBrutto": 5500,
      "quantity": 1,
      "discountTypeId": 1,
      "discountRate": 0,
      "discount": 500,
      "taxRate": null,
      "taxIncluded": false,
      "customized": "Y",
      "measureCode": 796,
      "measureName": "pcs",
      "sort": 0,
      "xmlId": "",
      "type": 7,
      "storeId": null
    }
  ]
}
```

## Error response example

400 — invalid format:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "items must be an array"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | The body contains a field name that is not among the writable fields — see [Product fields](/docs/entities/leads/products-fields) |
| 400 | `INVALID_PARAMS` | `items` is not an array |
| 400 | `INVALID_PARAMS` | An entry in the `items` array carries no writable product-row field — an empty object, or read-only fields only. The error text lists the writable names |
| 404 | `ENTITY_NOT_FOUND` | Lead not found. The message is `Owner was not found` |
| 403 | `SCOPE_DENIED` | The API key does not have the `crm` scope |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only — see [access rights](/docs/access-rights) |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

**Full replacement:** PUT replaces the entire product list. To add a row, first get the current ones (`GET`), add the new one to the array, and send everything back (`PUT`). Fetch the whole list: without `limit`, [`GET`](./products-get.md) returns only the first page, so pass `limit=5000` or page through with `offset` until `meta.hasMore` is `false`. Sending back an incomplete list erases everything it omits.

**An amount discount requires `discountTypeId: 1`.** The discount type defaults to `2`, a percentage, and in that mode the `discount` field is not stored: the row comes back with `discount: 0` and no error is raised. To set a discount as an amount, send `discountTypeId: 1` together with `discount`. To set it as a percentage, send `discountRate` with type `2`.

## See also

- [Product rows](/docs/entities/leads/products-get)
- [Get a lead](/docs/entities/leads/get)
- [CRM products](/docs/entities/products)
- [Limits and optimization](/docs/optimization)