Update Existing Company crm.company.update
Scope:
crmWho can execute the method: user with "Edit" access permission for companies
Method Development Stopped
The method crm.company.update is still operational, but there is a more current equivalent, crm.item.update.
The method crm.company.update updates an existing company.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Company identifier |
|
fields* |
Object format:
where:
The list of available fields is described in the method crm.company.fields. An incorrect field in |
|
params |
Object containing a set of additional parameters:
|
Parameter fields
|
Name |
Description |
|
TITLE |
Company name |
|
COMPANY_TYPE |
Company type. Values can be obtained using the method crm.status.list with a filter for |
|
LOGO |
Logo |
|
INDUSTRY |
Industry. Values can be obtained using the method crm.status.list with a filter for |
|
EMPLOYEES |
Number of employees. Values can be obtained using the method crm.status.list with a filter for |
|
CURRENCY_ID |
Currency |
|
REVENUE |
Annual revenue |
|
OPENED |
Is the company available to everyone. Possible values:
|
|
COMMENTS |
Comment |
|
ASSIGNED_BY_ID |
Responsible person |
|
CONTACT_ID |
Contact. Multiple |
|
ORIGINATOR_ID |
Data source identifier. Used only for linking to an external source |
|
ORIGIN_ID |
Identifier of the element in the data source. Used only for linking to an external source |
|
ORIGIN_VERSION |
Original version. Used to protect data from accidental overwriting by an external system |
|
UTM_SOURCE |
Advertising system. Google Ads, Bing Ads, etc. |
|
UTM_MEDIUM |
Traffic type. Possible values:
|
|
UTM_CAMPAIGN |
Advertising campaign designation |
|
UTM_CONTENT |
Campaign content. For example, for contextual ads |
|
UTM_TERM |
Campaign search condition. For example, keywords for contextual advertising |
|
PARENT_ID_... |
Relationship fields. If there are SPAs related to companies in the account, for each such SPA there is a field that stores the relationship between this SPA and the company. The field itself stores the identifier of the element of that SPA |
|
PHONE |
Phone. Multiple |
|
EMAIL |
E-mail. Multiple |
|
WEB |
Website. Multiple |
|
Messenger. Multiple |
|
|
LINK |
LINK. Multiple |
|
UF_... |
Custom fields. For example, Depending on the account settings, companies may have a set of custom fields of specific types. You can add a custom field to a company using the method crm.company.userfield.add |
To change the address and banking details of the company, use the methods for requisites
Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":43,"FIELDS":{"CURRENCY_ID":"USD","REVENUE":500000,"EMPLOYEES":"EMPLOYEES_3"},"PARAMS":{"REGISTER_SONET_EVENT":"Y","REGISTER_HISTORY_EVENT":"Y"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":43,"FIELDS":{"CURRENCY_ID":"USD","REVENUE":500000,"EMPLOYEES":"EMPLOYEES_3"},"PARAMS":{"REGISTER_SONET_EVENT":"Y","REGISTER_HISTORY_EVENT":"Y"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.company.update
try
{
const id = prompt("Enter ID");
const response = await $b24.callMethod(
"crm.company.update",
{
id: id,
fields:
{
"CURRENCY_ID": "USD",
"REVENUE" : 500000,
"EMPLOYEES": "EMPLOYEES_3"
},
params: { "REGISTER_SONET_EVENT": "Y" }
}
);
const result = response.getData().result;
if(result.error())
{
console.error(result.error());
}
else
{
console.info(result);
}
}
catch(error)
{
console.error('Error:', error);
}
$id = readline("Enter ID");
try {
$response = $b24Service
->core
->call(
'crm.company.update',
[
'id' => $id,
'fields' => [
'CURRENCY_ID' => 'USD',
'REVENUE' => 500000,
'EMPLOYEES' => 'EMPLOYEES_3',
],
'params' => ['REGISTER_SONET_EVENT' => 'Y'],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating company: ' . $e->getMessage();
}
var id = prompt("Enter ID");
BX24.callMethod(
"crm.company.update",
{
id: id,
fields:
{
"CURRENCY_ID": "USD",
"REVENUE" : 500000,
"EMPLOYEES": "EMPLOYEES_3"
},
params: { "REGISTER_SONET_EVENT": "Y" }
},
function(result)
{
if(result.error())
console.error(result.error());
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.company.update',
[
'id' => 43,
'fields' => [
'CURRENCY_ID' => 'USD',
'REVENUE' => 500000,
'EMPLOYEES' => 'EMPLOYEES_3',
],
'params' => [
'REGISTER_SONET_EVENT' => 'Y',
'REGISTER_HISTORY_EVENT' => 'Y',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": true,
"time": {
"start": 1769499930,
"finish": 1769499931.074515,
"duration": 1.0745151042938232,
"processing": 1,
"date_start": "2026-01-27T10:45:30+01:00",
"date_finish": "2026-01-27T10:45:31+01:00",
"operating_reset_at": 1769500530,
"operating": 0.2604348659515381
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response, returns |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Company is not found"
}
|
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 |
|
|
Parameter 'fields' must be array |
The parameter |
|
|
Parameter 'params' must be array |
The parameter |
|
|
Access denied |
User does not have "Edit" access permission for companies |
|
|
Disk resource exhausted |
|
|
|
Field |
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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create a New Company crm.company.add
- Get Company Information crm.company.get
- Get a List of Companies by Filter crm.company.list
- Delete Company crm.company.delete
- Get Company Field Descriptions crm.company.fields
- How to Change or Delete Phone Numbers and Emails