Create a New Company crm.company.add
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: a user with "Add|Import" access permission for companies
DEPRECATED
The development of this method has been halted. Please use crm.item.add.
The method crm.company.add creates a new company.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object format:
where:
The list of available fields is described in the method crm.company.fields. An incorrect field in
To find out the list of required fields, execute the method crm.company.fields. |
|
params |
An object containing a set of additional parameters:
|
Parameter fields
|
Name |
Description |
|
TITLE |
Company name |
|
COMPANY_TYPE |
Company type. The list of available types can be obtained using the method crm.status.list with the filter Default — the first available company type |
|
INDUSTRY |
Industry. The list of available values can be obtained using the method crm.status.list with the filter Default — the first available industry |
|
EMPLOYEES |
Number of employees. The list of available values can be obtained using the method crm.status.list with the filter Default — the first available value |
|
CURRENCY_ID |
Currency. The list of available currencies can be obtained using the method crm.currency.list |
|
REVENUE |
Annual revenue |
|
LOGO |
Company logo |
|
OPENED |
Is the company available to everyone? Possible values:
Default is |
|
ASSIGNED_BY_ID |
Identifier of the user responsible for the element. Default — the identifier of the user calling the method |
|
COMMENTS |
Comment |
|
PHONE |
Phone |
|
EMAIL |
|
|
WEB |
Website |
|
Messenger |
|
|
UTM_SOURCE |
Advertising system, e.g., Google Ads |
|
UTM_MEDIUM |
Traffic type. Possible values:
|
|
UTM_CAMPAIGN |
Advertising campaign designation |
|
UTM_CONTENT |
Campaign content. For example, for contextual ads |
|
UTM_TERM |
Campaign search term. For example, keywords for contextual advertising |
|
IS_MY_COMPANY |
Is the company "my company"? Possible values:
|
|
UF_... |
Custom fields. For example, Depending on the portal 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 |
|
PARENT_ID_... |
Relationship fields. If there are smart processes related to companies on the portal, there is a field for each such smart process that stores the relationship between this smart process and the company. The field itself stores the identifier of the element of that smart process |
Fields for connections with external data sources
If the company is created by an external system, then:
- the field
ORIGINATOR_IDstores the string identifier of that system - the field
ORIGIN_IDstores the string identifier of the company in that external system - the field
ORIGIN_VERSIONstores the version of the company data in that external system
|
Name |
Description |
|
ORIGINATOR_ID |
Identifier of the external system that is the source of data about this company |
|
ORIGIN_ID |
Identifier of the company in the external system |
|
ORIGIN_VERSION |
Version of the data in the external system. Used to protect data from accidental overwriting |
Import
These fields are available for filling when the parameter IMPORT = 'Y' is passed in the params parameter.
|
Name |
Description |
|
DATE_CREATE |
Creation date |
|
DATE_MODIFY |
Modification date |
|
CREATED_BY_ID |
Created by |
|
MODIFY_BY_ID |
Modified by |
To add the company's address and banking details, use the methods from requisites.
Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TITLE":"John Doe LLC","COMPANY_TYPE":"CUSTOMER","INDUSTRY":"MANUFACTURING","EMPLOYEES":"EMPLOYEES_2","CURRENCY_ID":"USD","REVENUE":3000000,"OPENED":"Y","ASSIGNED_BY_ID":1,"PHONE":[{"VALUE":"555888","VALUE_TYPE":"WORK"}]},"params":{"REGISTER_SONET_EVENT":"Y"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TITLE":"John Doe LLC","COMPANY_TYPE":"CUSTOMER","INDUSTRY":"MANUFACTURING","EMPLOYEES":"EMPLOYEES_2","CURRENCY_ID":"USD","REVENUE":3000000,"OPENED":"Y","ASSIGNED_BY_ID":1,"PHONE":[{"VALUE":"555888","VALUE_TYPE":"WORK"}]},"params":{"REGISTER_SONET_EVENT":"Y"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.company.add
// 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<number>({
method: 'crm.company.add',
params: {
fields: {
TITLE: 'Titov Sole Proprietor',
COMPANY_TYPE: 'CUSTOMER',
INDUSTRY: 'MANUFACTURING',
EMPLOYEES: 'EMPLOYEES_2',
CURRENCY_ID: 'USD',
REVENUE: 3000000,
LOGO: { fileData: document.getElementById('logo') },
OPENED: 'Y',
ASSIGNED_BY_ID: 1,
PHONE: [{ VALUE: '555888', VALUE_TYPE: 'WORK' }],
},
params: { REGISTER_SONET_EVENT: 'Y' },
},
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('Created company id:', 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 addCompany() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.company.add',
params: {
fields: {
TITLE: 'Titov Sole Proprietor',
COMPANY_TYPE: 'CUSTOMER',
INDUSTRY: 'MANUFACTURING',
EMPLOYEES: 'EMPLOYEES_2',
CURRENCY_ID: 'USD',
REVENUE: 3000000,
LOGO: { fileData: document.getElementById('logo') },
OPENED: 'Y',
ASSIGNED_BY_ID: 1,
PHONE: [{ VALUE: '555888', VALUE_TYPE: 'WORK' }],
},
params: { REGISTER_SONET_EVENT: 'Y' },
},
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('Created company id:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCompany)
</script>
try {
$response = $b24Service
->core
->call(
'crm.company.add',
[
'fields' => [
'TITLE' => 'John Doe LLC',
'COMPANY_TYPE' => 'CUSTOMER',
'INDUSTRY' => 'MANUFACTURING',
'EMPLOYEES' => 'EMPLOYEES_2',
'CURRENCY_ID' => 'USD',
'REVENUE' => 3000000,
'LOGO' => ['fileData' => $_POST['logo']],
'OPENED' => 'Y',
'ASSIGNED_BY_ID' => 1,
'PHONE' => [['VALUE' => '555888', 'VALUE_TYPE' => 'WORK']],
],
'params' => ['REGISTER_SONET_EVENT' => 'Y'],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Company created with ID ' . $result;
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating company: ' . $e->getMessage();
}
BX24.callMethod(
"crm.company.add",
{
fields:
{
"TITLE": "John Doe LLC",
"COMPANY_TYPE": "CUSTOMER",
"INDUSTRY": "MANUFACTURING",
"EMPLOYEES": "EMPLOYEES_2",
"CURRENCY_ID": "USD",
"REVENUE" : 3000000,
"LOGO": { "fileData": document.getElementById('logo') },
"OPENED": "Y",
"ASSIGNED_BY_ID": 1,
"PHONE": [ { "VALUE": "555888", "VALUE_TYPE": "WORK" } ]
},
params: { "REGISTER_SONET_EVENT": "Y" }
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.info("Company created with ID " + result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.company.add',
[
'fields' => [
'TITLE' => 'John Doe LLC',
'COMPANY_TYPE' => 'CUSTOMER',
'INDUSTRY' => 'MANUFACTURING',
'EMPLOYEES' => 'EMPLOYEES_2',
'CURRENCY_ID' => 'USD',
'REVENUE' => 3000000,
'OPENED' => 'Y',
'ASSIGNED_BY_ID' => 1,
'PHONE' => [['VALUE' => '555888', 'VALUE_TYPE' => 'WORK']],
],
'params' => ['REGISTER_SONET_EVENT' => 'Y'],
]
);
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.add", b24.Params{
"fields": b24.Params{
"TITLE": "John Doe LLC",
"COMPANY_TYPE": "CUSTOMER",
"INDUSTRY": "MANUFACTURING",
"EMPLOYEES": "EMPLOYEES_2",
"CURRENCY_ID": "EUR",
"REVENUE": 3000000,
"OPENED": "Y",
"ASSIGNED_BY_ID": 1,
"PHONE": []b24.Params{
{
"VALUE": "555888",
"VALUE_TYPE": "WORK",
},
},
},
"params": b24.Params{
"REGISTER_SONET_EVENT": "Y",
},
})
if err != nil {
return fmt.Errorf("crm.company.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
Response Handling
HTTP Status: 200
{
"result": 2921,
"time": {
"start": 1769500710,
"finish": 1769500711.551784,
"duration": 1.5517840385437012,
"processing": 1,
"date_start": "2026-01-27T10:58:30+01:00",
"date_finish": "2026-01-27T10:58:31+01:00",
"operating_reset_at": 1769501310,
"operating": 0.6509370803833008
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response, contains the identifier of the created company |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Parameter 'fields' must be array."
}
|
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 |
|
Empty value |
Parameter 'fields' must be array |
The |
|
Empty value |
Parameter 'params' must be array |
The |
|
Empty value |
Access denied |
The user does not have permission for "Add" or "Import" companies |
|
Empty value |
Disk resource exhausted |
|
|
|
The |
The |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |