Update Existing Company crm.company.update

Scope: crm

Who 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
type

Description

id*
integer

Company identifier

fields*
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
        

where:

  • field_n — field name
  • value_n — new field value

The list of available fields is described in the method crm.company.fields.

An incorrect field in fields will be ignored

params
object

Object containing a set of additional parameters:

  • REGISTER_SONET_EVENT — send notification to the responsible person
  • REGISTER_HISTORY_EVENT — register event in history. Possible values:
    • Y — yes
    • N — no

Parameter fields

Name
type

Description

TITLE
string

Company name

COMPANY_TYPE
crm_status

Company type. Values can be obtained using the method crm.status.list with a filter for ENTITY_ID=COMPANY_TYPE

LOGO
file

Logo

INDUSTRY
crm_status

Industry. Values can be obtained using the method crm.status.list with a filter for ENTITY_ID=INDUSTRY

EMPLOYEES
crm_status

Number of employees. Values can be obtained using the method crm.status.list with a filter for ENTITY_ID=EMPLOYEES

CURRENCY_ID
crm_currency

Currency

REVENUE
double

Annual revenue

OPENED
char

Is the company available to everyone. Possible values:

  • Y — yes
  • N — no

COMMENTS
string

Comment

ASSIGNED_BY_ID
user

Responsible person

CONTACT_ID
crm_contact

Contact. Multiple

ORIGINATOR_ID
string

Data source identifier. Used only for linking to an external source

ORIGIN_ID
string

Identifier of the element in the data source. Used only for linking to an external source

ORIGIN_VERSION
string

Original version. Used to protect data from accidental overwriting by an external system

UTM_SOURCE
string

Advertising system. Google Ads, Bing Ads, etc.

UTM_MEDIUM
string

Traffic type. Possible values:

  • CPC — ads
  • CPM — banners

UTM_CAMPAIGN
string

Advertising campaign designation

UTM_CONTENT
string

Campaign content. For example, for contextual ads

UTM_TERM
string

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
crm_multifield[]

Phone. Multiple

EMAIL
crm_multifield[]

E-mail. Multiple

WEB
crm_multifield[]

Website. Multiple

IM
crm_multifield[]

Messenger. Multiple

LINK
crm_multifield[]

LINK. Multiple

UF_...

Custom fields. For example, UF_CRM_25534736.

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
type

Description

result
boolean

Root element of the response, returns true on success

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Company is not found"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
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 fields is not an object

-

Parameter 'params' must be array

The parameter params is not an object

-

Access denied

User does not have "Edit" access permission for companies

-

Disk resource exhausted

ERROR_CORE

Field E-mail contains an invalid address

Field E-mail contains an invalid address

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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