For AI agents: markdown of this page — /docs-content-en/entities/catalog-product-property-enums/delete.md documentation index — /llms.txt

Delete a list-property value

DELETE /v1/catalog-product-property-enums/:id

Deletes an option of a catalog list property by identifier. A deleted option cannot be restored via the API.

Before deleting, verify that products no longer use this value.

Parameters

Parameter Type Required Description
id (path) number yes Value identifier from the list of values

Examples

curl — personal key

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/catalog-product-property-enums/1769" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/catalog-product-property-enums/1769" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-product-property-enums/1769', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

if (res.status === 204) {
  console.log('Value deleted')
}

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-product-property-enums/1769', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

if (res.status === 204) {
  console.log('Value deleted')
}

Response

On successful deletion, HTTP status 204 No Content is returned with an empty body. Success is checked by the response status.

Response example

http 
HTTP/1.1 204 No Content

Error response example

404 — the value is already deleted:

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

Errors

HTTP Code Description
400 INVALID_PARAMS Invalid id in the path
404 ENTITY_NOT_FOUND No value with the specified identifier exists
422 BITRIX_ERROR Bitrix24 rejected the deletion. The reason is in error.message
403 SCOPE_DENIED The API key lacks the catalog scope
403 WRITE_BLOCKED_READONLY_KEY The API key allows read access only
401 MISSING_API_KEY The X-Api-Key header was not passed

Full list of common API errors — Errors.

See also