For AI agents: markdown of this page — /docs-content-en/entities/products/update.md documentation index — /llms.txt

Update product

PATCH /v1/products/:id

Updates a CRM catalog product. Pass only the fields being changed, flat at the JSON root — without the fields wrapper. The response returns the full object of the updated product.

Parameters

Parameter Type Required Description
id (path) number yes Product identifier. List: GET /v1/products

Request fields (body)

Field Bitrix24 Type Required Description
name NAME string no Product name
price PRICE number no Product price. Currency is set by currency
currency CURRENCY_ID string no Price currency. List: GET /v1/currencies
active ACTIVE boolean no Whether the product is active
sectionId SECTION_ID number no Catalog section. List: GET /v1/product-sections
catalogId CATALOG_ID number no Product catalog. List: GET /v1/catalogs
measure MEASURE number no Measurement unit identifier
description DESCRIPTION string no Product description
descriptionType DESCRIPTION_TYPE string no Description format: text or html
vatId VAT_ID number no VAT rate identifier
vatIncluded VAT_INCLUDED boolean no VAT included in the price
sort SORT number no Sort order
xmlId XML_ID string no External identifier
code CODE string no Symbolic product code
createdBy CREATED_BY number RO Identifier of the employee who created it
modifyBy MODIFIED_BY number RO Identifier of the employee who modified it
createdAt DATE_CREATE datetime RO Creation date
updatedAt TIMESTAMP_X datetime RO Last modification date

Examples

curl — personal key

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/products/7027" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "price": 150
  }'

curl — OAuth app

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/products/7027" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "price": 150
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/products/7027', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    price: 150,
  }),
})

const { success, data } = await res.json()
console.log('New price:', data.price)

JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/products/7027', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    price: 150,
  }),
})

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

Response fields

Field Type Description
success boolean Always true on success
data object The updated product object: basic fields — see Product fields, plus the custom PROPERTY_<N> properties

Response example

The main fields are shown. The response also includes catalog properties of the form PROPERTY_<N> — see Get product.

JSON 
{
  "success": true,
  "data": {
    "id": 7027,
    "name": "Desk lamp",
    "code": "desk_lamp",
    "active": true,
    "previewPicture": null,
    "detailPicture": null,
    "sort": 500,
    "xmlId": "7027",
    "updatedAt": "2026-06-16T08:48:21.000Z",
    "createdAt": "2026-06-16T08:48:18.000Z",
    "modifyBy": 1,
    "createdBy": 1,
    "catalogId": 25,
    "sectionId": null,
    "description": null,
    "descriptionType": "text",
    "price": 150,
    "currency": "USD",
    "vatId": null,
    "vatIncluded": false,
    "measure": null
  }
}

Error response example

404 — product not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Product is not found."
  }
}

Errors

HTTP Code Description
404 ENTITY_NOT_FOUND A product with this id was not found
403 SCOPE_DENIED API key does not have the crm scope
401 MISSING_API_KEY The X-Api-Key header was not passed

Full list of common API errors — Errors.

See also