Delete Custom Field for Leads crm.lead.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:
crmWho can execute the method: CRM administrator
The method crm.lead.userfield.delete removes a custom field for leads.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the custom field associated with the lead. The identifier can be obtained using the methods crm.lead.userfield.add or crm.lead.userfield.list |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":432}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.userfield.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":432,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.userfield.delete
try
{
const response = await $b24.callMethod(
'crm.lead.userfield.delete',
{
id: 432,
}
);
const result = response.getData().result;
result.error()
? console.error(result.error())
: console.info(result)
;
}
catch( error )
{
console.error('Error:', error);
}
try {
$userfieldId = 123; // Replace with the actual userfield ID you want to delete
$result = $serviceBuilder
->getCRMScope()
->leadUserfield()
->delete($userfieldId);
if ($result->isSuccess()) {
print("Userfield deleted successfully.");
} else {
print("Failed to delete userfield.");
}
} catch (Throwable $e) {
print("An error occurred: " . $e->getMessage());
}
BX24.callMethod(
'crm.lead.userfield.delete',
{
id: 432,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.userfield.delete',
[
'id' => 432
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": true,
"time": {
"start": 1724419843.518672,
"finish": 1724419844.120328,
"duration": 0.6016559600830078,
"processing": 0.1907808780670166,
"date_start": "2024-08-23T15:30:43+02:00",
"date_finish": "2024-08-23T15:30:44+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response, contains |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Access denied."
}
|
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
|
Code |
Description |
Value |
|
|
ID is not defined or invalid |
The provided |
|
|
Access denied |
Occurs when:
|
|
|
The entity with ID 'id' is not found |
The custom field with the provided |
|
|
Error deleting FIELD_NAME for object ENTITY_ID |
Unknown error during deletion |
Continue Learning
- Create a Custom Field for Leads crm.lead.userfield.add
- Get Custom Lead Field by ID crm.lead.userfield.get
- Get a List of Custom Fields for Leads crm.lead.userfield.list
- Update Existing Custom Field for Leads crm.lead.userfield.update