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

Delete item

DELETE /v1/items/:entityTypeId/:id

Deletes a smart process item by ID. A deleted item cannot be restored through the API — create a new one if needed.

Use the entityTypeId field from GET /v1/smart-processes in the /v1/items/:entityTypeId path. The type record's internal id is a different identifier. For example, if a type is returned as { "id": 3, "entityTypeId": 174 }, the path starts with /v1/items/174. Use the returned value rather than assuming all type IDs start at 1030.

Parameters

Parameter Type Required Description
ParameterentityTypeId (path) Typenumber Requiredyes DescriptionSmart process type ID. List: GET /v1/smart-processes. Reserved values (1, 2, 3, 4, 7, 31) are served by specialized APIs: /v1/leads, /v1/deals, /v1/contacts, /v1/companies, /v1/quotes, /v1/invoices
Parameterid (path) Typenumber Requiredyes DescriptionItem ID

Examples

The examples use entityTypeId = 177 and id = 783; replace them with your values.

curl — personal key

Terminal
curl -X DELETE "https://vibecode.bitrix24.com/v1/items/177/783" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal
curl -X DELETE "https://vibecode.bitrix24.com/v1/items/177/783" \
  -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/items/177/783', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

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

JavaScript — OAuth application

javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/items/177/783', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response

On success, the API returns 204 No Content with an empty body — check the status code to confirm success.

Response example

HTTP/1.1 204 No Content

Error response example

400 — reserved entityTypeId (for standard CRM entities):

JSON
{
  "success": false,
  "error": {
    "code": "INVALID_DYNAMIC_PARAM",
    "message": "entityTypeId 2 has a dedicated API: use /v1/deals instead"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_DYNAMIC_PARAM DescriptionentityTypeId is not a positive integer or is reserved (1, 2, 3, 4, 7, 31)
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo item found with the specified ID
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

See also