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

Delete dictionary record

DELETE /v1/statuses/:id

Deletes a CRM dictionary record by ID. System records (system: true) cannot be deleted.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionDictionary record ID

Examples

curl — personal key

Terminal 
curl -X DELETE "https://vibecode.bitrix24.com/v1/statuses/42" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

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

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

JavaScript — OAuth application

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

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

Response

On successful deletion, the API returns HTTP status 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

422 — the record is not found or is a system record:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Status is not found."
  }
}

Errors

HTTP Code Description
HTTP422 CodeBITRIX_ERROR DescriptionThe record is not found, is a system record (system: true), or the ID is invalid
HTTP422 CodeBITRIX_ERROR DescriptionThe stage still has items, with the message There are active items in this status. Move the items to another stage and retry the deletion
HTTP403 CodeSCOPE_DENIED DescriptionAPI key does not have the crm scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing

Full list of errors — Errors.

See also