Update catalog product

PATCH /v1/catalog-products/:id

Updates an existing product. Fields are passed flat at the root of the JSON. Pass only the fields you want to change — the rest keep their current values. The response returns the full object of the updated product.

Parameters

Request fields (body)

Custom product properties are passed as propertyNNN; on-premise fields (recurSchemeType, recurSchemeLength, trialPriceId) are accepted too. Full field list — GET /v1/catalog-products/fields.

The body must carry at least one writable field. An empty PATCH ({}) is rejected with 400 EMPTY_UPDATE_BODY, and a PATCH that carries no recognized writable field (for example, only typos) is rejected with 400 NO_RECOGNIZED_UPDATE_FIELDS. Previously such a request returned 200 with the unchanged object, misleading the client. The object fields iblockSection/previewPicture/detailPicture are writable but cannot be used for filtering or sorting (the request is rejected with an explicit UNKNOWN_FILTER_FIELD/UNKNOWN_SORT_FIELD error); for reliable filtering use the indexable fields (code, xmlId, sort, vatId, dimensions).

id is passed in the path; it cannot be passed in the body — it is read-only. The available and bundle fields are computed by Bitrix24, and writing them returns READONLY_FIELD. iblockId is set on create only: changing the catalog via PATCH is rejected with READONLY_FIELD — Bitrix24 does not move a product between catalogs (previously such a request returned 200 while the product remained in its original catalog). The audit fields createdBy and modifiedBy are filled by the system, and writing them also returns READONLY_FIELD.

Examples

curl — personal key

curl -X PATCH "https://vibecode.bitrix24.com/v1/catalog-products/541" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "USB-C cable, 2 m"
  }'

curl — OAuth application

curl -X PATCH "https://vibecode.bitrix24.com/v1/catalog-products/541" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "USB-C cable, 2 m"
  }'

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-products/541', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'USB-C cable, 2 m',
  }),
})

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

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-products/541', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'USB-C cable, 2 m',
  }),
})

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

Response fields

Response example

The main fields are shown.

{
  "success": true,
  "data": {
    "id": 541,
    "iblockId": 25,
    "iblockSectionId": null,
    "name": "USB-C cable, 2 m",
    "active": true,
    "measure": 9,
    "available": true,
    "bundle": false,
    "canBuyZero": true,
    "quantityTrace": false,
    "subscribe": true,
    "vatIncluded": false,
    "purchasingPrice": 110,
    "purchasingCurrency": "USD",
    "quantity": null,
    "dateCreate": "2021-08-06T12:59:15.000Z",
    "timestampX": "2026-06-15T13:11:33.000Z",
    "xmlId": "541"
  }
}

Error response example

404 — no product with the specified id exists:

{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "product does not exist."
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

A catalog property is passed as an object. A PATCH with a scalar property value — "property301": "A-200" — returns 200 but does not write the value: a string property is cleared, and a checkbox keeps its previous value. Pass { "value": … } — this changes both a string and a "Y"/"N" checkbox. When you create a product, a property also accepts a plain value.

See also

• Create catalog product
• List catalog products
• Get catalog product
• Delete catalog product
• Catalog prices
• Batch
• Limits and optimization