Создать новую компанию crm.company.add

Scope: crm

Кто может выполнять метод: пользователь с правом «Добавление|Импорт» компаний

DEPRECATED

Развитие метода остановлено. Используйте crm.item.add.

Метод crm.company.add создает новую компанию.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект формата:

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

где:

  • field_n — название поля
  • value_n — значение поля

Список доступных полей описан в методе crm.company.fields.

Некорректное поле в fields будет проигнорировано

Чтобы узнать перечень обязательных полей, выполните метод crm.company.fields

params
object

Объект, содержащий набор дополнительных параметров:

  • REGISTER_SONET_EVENT — регистрировать событие добавления компании и отправить уведомление ответственному
  • IMPORT — режим импорта. Возможные значения:
    • Y — да
    • N — нет

Параметр fields

Название
тип

Описание

TITLE
string

Название компании

COMPANY_TYPE
crm_status

Тип компании.

Список доступных типов можно узнать с помощью метода crm.status.list, применив фильтр { ENTITY_ID: "COMPANY_TYPE" }.

По умолчанию — первый доступный тип компании

INDUSTRY
crm_status

Сфера деятельности.

Список доступных значений можно узнать с помощью метода crm.status.list, применив фильтр { ENTITY_ID: "INDUSTRY" }.

По умолчанию — первая доступная сфера деятельности

EMPLOYEES
crm_status

Количество сотрудников.

Список доступных значений можно узнать с помощью метода crm.status.list, применив фильтр { ENTITY_ID: "EMPLOYEES" }.

По умолчанию — первое доступное значение

CURRENCY_ID
crm_currency

Валюта.

Список доступных валют можно узнать с помощью метода crm.currency.list

REVENUE
double

Годовой оборот

LOGO
file

Логотип компании

OPENED
char

Доступна ли компания для всех. Возможные значения:

  • Y — да
  • N — нет

По умолчанию Y. Значение по умолчанию может быть изменено в настройках CRM

ASSIGNED_BY_ID
user

Идентификатор пользователя, ответственного за элемент.

По умолчанию — идентификатор пользователя, который вызывает метод

COMMENTS
string

Комментарий

PHONE
crm_multifield[]

Телефон

EMAIL
crm_multifield[]

E-mail

WEB
crm_multifield[]

Сайт

IM
crm_multifield[]

Мессенджер

UTM_SOURCE
string

Рекламная система, например Yandex-Direct, Google-Adwords

UTM_MEDIUM
string

Тип трафика. Возможные значения:

  • CPC — объявления
  • CPM — баннеры

UTM_CAMPAIGN
string

Обозначение рекламной кампании

UTM_CONTENT
string

Содержание кампании. Например, для контекстных объявлений

UTM_TERM
string

Условие поиска кампании. Например, ключевые слова контекстной рекламы

IS_MY_COMPANY
char

Является ли компания «моей компанией». Возможные значения:

  • Y — да
  • N — нет

UF_...

Пользовательские поля. Например, UF_CRM_25534736.

В зависимости от настроек портала у компаний может быть набор пользовательских полей определенных типов.

Добавить пользовательское поле в компанию можно с помощью метода crm.company.userfield.add

PARENT_ID_...

Поля связей.

Если на портале есть смарт-процессы, связанные с компаниями, для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и компанией. Само поле хранит идентификатор элемента такого смарт-процесса

Поля связи с внешними источниками данных

Если компания создана внешней системой, то:

  • поле ORIGINATOR_ID хранит строковый идентификатор этой системы
  • поле ORIGIN_ID хранит строковый идентификатор компании в этой внешней системе
  • поле ORIGIN_VERSION хранит версию данных компании в этой внешней системе

Название
тип

Описание

ORIGINATOR_ID
string

Идентификатор внешней системы, являющейся источником данных об этой компании

ORIGIN_ID
string

Идентификатор компании во внешней системе

ORIGIN_VERSION
string

Версия данных во внешней системе. Используется для защиты данных от случайного перетирания

Импорт

Данные поля доступны для заполнения при передаче параметра IMPORT = 'Y' в параметр params.

Название
тип

Описание

DATE_CREATE
datetime

Дата создания

DATE_MODIFY
datetime

Дата изменения

CREATED_BY_ID
user

Кем создана

MODIFY_BY_ID
user

Кем изменена

Чтобы добавить адрес и банковские реквизиты компании, используйте методы реквизитов

Примеры

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"TITLE":"ИП Титов","COMPANY_TYPE":"CUSTOMER","INDUSTRY":"MANUFACTURING","EMPLOYEES":"EMPLOYEES_2","CURRENCY_ID":"RUB","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":"ИП Титов","COMPANY_TYPE":"CUSTOMER","INDUSTRY":"MANUFACTURING","EMPLOYEES":"EMPLOYEES_2","CURRENCY_ID":"RUB","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
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.company.add",
        		{
        			fields:
        			{
        				"TITLE": "ИП Титов",
        				"COMPANY_TYPE": "CUSTOMER",
        				"INDUSTRY": "MANUFACTURING",
        				"EMPLOYEES": "EMPLOYEES_2",
        				"CURRENCY_ID": "RUB",
        				"REVENUE" : 3000000,
        				"LOGO": { "fileData": document.getElementById('logo') },
        				"OPENED": "Y",
        				"ASSIGNED_BY_ID": 1,
        				"PHONE": [ { "VALUE": "555888", "VALUE_TYPE": "WORK" } ]     
        			},
        			params: { "REGISTER_SONET_EVENT": "Y" }        
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info("Создана компания с ID " + result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.add',
                    [
                        'fields' => [
                            'TITLE'         => 'ИП Титов',
                            'COMPANY_TYPE'  => 'CUSTOMER',
                            'INDUSTRY'      => 'MANUFACTURING',
                            'EMPLOYEES'     => 'EMPLOYEES_2',
                            'CURRENCY_ID'   => 'RUB',
                            '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 'Создана компания с ID ' . $result;
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Ошибка при создании компании: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.company.add",
            {
                fields:
                {
                    "TITLE": "ИП Титов",
                    "COMPANY_TYPE": "CUSTOMER",
                    "INDUSTRY": "MANUFACTURING",
                    "EMPLOYEES": "EMPLOYEES_2",
                    "CURRENCY_ID": "RUB",
                    "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("Создана компания с ID " + result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.add',
            [
                'fields' => [
                    'TITLE' => 'ИП Титов',
                    'COMPANY_TYPE' => 'CUSTOMER',
                    'INDUSTRY' => 'MANUFACTURING',
                    'EMPLOYEES' => 'EMPLOYEES_2',
                    'CURRENCY_ID' => 'RUB',
                    '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>';
        

Обработка ответа

HTTP-статус: 200

{
            "result": 2921,
            "time": {
                "start": 1769500710,
                "finish": 1769500711.551784,
                "duration": 1.5517840385437012,
                "processing": 1,
                "date_start": "2026-01-27T10:58:30+03:00",
                "date_finish": "2026-01-27T10:58:31+03:00",
                "operating_reset_at": 1769501310,
                "operating": 0.6509370803833008
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
integer

Корневой элемент ответа, содержит идентификатор созданной компании

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "",
            "error_description": "Parameter 'fields' must be array."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

-

Parameter 'fields' must be array

В параметр fields передан не объект

-

Parameter 'params' must be array

В параметр params передан не объект

-

Access denied

У пользователя нет прав на «Добавление» или «Импорт» компаний

-

Исчерпан выделенный дисковый ресурс

ERROR_CORE

Поле E-mail содержит некорректный адрес

Поле E-mail содержит некорректный адрес

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение