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

Delete a field

DELETE /v1/lists/:iblockId/fields/:fieldId

Deletes a field from a list together with this field's values across all elements. A deleted field cannot be restored through the API — create a new one if needed.

Parameters

Parameter Type Required Description
iblockId (path) string yes List identifier — numeric IBLOCK_ID or symbolic IBLOCK_CODE. List of lists: GET /v1/lists
fieldId (path) string yes Field identifier in the form PROPERTY_<number> or symbolic code. List of fields: GET /v1/lists/:iblockId/fields
iblockTypeId (query) string no Info block type. Values:
lists — regular lists, default
lists_socnet — workgroup lists
bitrix_processes — service workflows

Examples

curl — personal key

Terminal 
curl -X DELETE https://vibecode.bitrix24.com/v1/lists/23/fields/PROPERTY_1177 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X DELETE https://vibecode.bitrix24.com/v1/lists/23/fields/PROPERTY_1177 \
  -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/lists/23/fields/PROPERTY_1177', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
if (res.status === 204) {
  console.log('Field deleted')
}

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/lists/23/fields/PROPERTY_1177', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
if (res.status === 204) {
  console.log('Field deleted')
}

Response

On successful deletion an HTTP status 204 No Content with an empty body is returned. The success indicator is the response code, not the body.

Response example

HTTP/1.1 204 No Content

Error response example

403 — no rights to the list:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "No permission to view and edit the list."
  }
}

Errors

HTTP Code Description
400 INVALID_IBLOCK_TYPE iblockTypeId is not one of lists, bitrix_processes, lists_socnet
422 BITRIX_ERROR Bitrix24 rejected the deletion, text in message
403 BITRIX_ACCESS_DENIED No permission to edit the list
403 WRITE_BLOCKED_READONLY_KEY The key is in read-only mode
403 SCOPE_DENIED The key lacks the lists scope
401 TOKEN_MISSING The key has no configured tokens
409 LISTS_MODULE_NOT_ENABLED The "Lists" module is not enabled on the portal

Full list of common API errors — Errors.

See also