Delete User Field task.item.userfield.delete
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: administrator
The method task.item.userfield.delete removes a user-defined field from a task.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ID* |
Identifier of the user-defined field. The identifier of the task's user-defined field can be obtained when creating a field or by using the method to get the list of fields |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"ID": 1325
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"ID": 1325,
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/task.item.userfield.delete
try
{
const response = await $b24.callMethod(
'task.item.userfield.delete',
{
ID: 1325
}
);
const result = response.getData().result;
console.log(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'task.item.userfield.delete',
[
'ID' => 1325
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'task.item.userfield.delete',
{
ID: 1325
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'task.item.userfield.delete',
[
'ID' => 1325
]
);
print_r($result);
Response Handling
HTTP Status: 200
{
"result": true,
"time": {
"start": 1772711218,
"finish": 1772711218.704123,
"duration": 0.7041230201721191,
"processing": 0,
"date_start": "2026-03-05T14:46:58+01:00",
"date_finish": "2026-03-05T14:46:58+01:00",
"operating_reset_at": 1772711818,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Returns |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "ERROR_CORE",
"error_description": "ID is not defined or invalid."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
TASKS_ERROR_EXCEPTION_#0; Invalid arguments for Bitrix\Tasks\Integration\Rest\Task\UserField::delete; 0/TE |
Required parameter |
|
|
|
ID is not defined or invalid |
The parameter |
|
|
|
The entity with ID '{ID}' is not found |
The user-defined field with the specified |
|
|
|
Access denied |
Insufficient permissions to delete the user-defined field |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Custom Fields in Tasks: Overview of Methods
- Add Custom Field task.item.userfield.add
- Update Custom Field task.item.userfield.update
- Get User Field of Task by ID task.item.userfield.get
- Get a List of Custom Fields task.item.userfield.getlist
- Get a List of Available Data Types for task.item.userfield.gettypes
- Get Custom Field Data with task.item.userfield.getfields