Delete Custom Field for Companies crm.company.userfield.delete
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: CRM administrator
The method crm.company.userfield.delete removes a custom field for companies.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the custom field associated with the company. The identifier can be obtained using the methods crm.company.userfield.add or crm.company.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.company.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.company.userfield.delete
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'crm.company.userfield.delete',
params: {
id: 432,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Userfield deleted:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function deleteCompanyUserfield() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.company.userfield.delete',
params: {
id: 432,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Userfield deleted:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteCompanyUserfield)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.company.userfield.delete(
bitrix_id=432,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$userfieldId = 123; // Replace with the actual userfield ID you want to delete
$result = $serviceBuilder
->getCRMScope()`r `n ->companyUserfield()
->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.company.userfield.delete',
{
id: 432,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.company.userfield.delete',
[
'id' => 432
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.company.userfield.delete", b24.Params{
"id": 432,
})
if err != nil {
return fmt.Errorf("crm.company.userfield.delete: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
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 |