Установить набор контактов, связанных с указанной компанией crm.company.contact.items.set

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

Метод crm.company.contact.items.set устанавливает набор контактов, связанных с указанной компанией.

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

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

Название
тип

Описание

id*
integer

Идентификатор компании.

Идентификатор можно получить с помощью методов crm.company.list или crm.company.add

items*
object[]

Набор объектов, которые описывают привязанные контакты к компании. Структура отдельно взятого объекта привязки смотрите ниже

Структура объекта привязки

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

Название
тип

Описание

CONTACT_ID*
crm_entity

Идентификатор контакта, который будет привязан к компании.

Идентификатор можно получить с помощью метода crm.item.list по entityTypeId = 3

IS_PRIMARY
char

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

  • Y — да
  • N — нет

Если нет привязки с IS_PRIMARY = Y, то она выставляется у первой привязки в items.

Если передано несколько привязок с IS_PRIMARY = Y, то первичной будет считаться первая привязка с IS_PRIMARY = Y

SORT
integer

Индекс сортировки.

По умолчанию i + 10, где i — максимальный индекс сортировки у существующих и переданных привязок для текущей компании или 0 в случае, если SORT не передан ни у одной из привязок и если у компании отсутствуют привязки.

Если передана уже существующая привязка без параметра SORT, то значение по умолчанию не выставится, значение останется тем же

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":32,"items":[{"CONTACT_ID":8,"IS_PRIMARY":"Y","SORT":100},{"CONTACT_ID":9,"SORT":200},{"CONTACT_ID":10,"SORT":400}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.contact.items.set
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":32,"items":[{"CONTACT_ID":8,"IS_PRIMARY":"Y","SORT":100},{"CONTACT_ID":9,"SORT":200},{"CONTACT_ID":10,"SORT":400}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.contact.items.set
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.company.contact.items.set',
        		{
        			id: 32,
        			items: [
        				{
        					CONTACT_ID: 8,
        					IS_PRIMARY: "Y",
        					SORT: 100,
        				},
        				{
        					CONTACT_ID: 9,
        					SORT: 200,
        				},
        				{
        					CONTACT_ID: 10,
        					SORT: 400,
        				}
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.contact.items.set',
                    [
                        'id'    => 32,
                        'items' => [
                            [
                                'CONTACT_ID' => 8,
                                'IS_PRIMARY' => 'Y',
                                'SORT'       => 100,
                            ],
                            [
                                'CONTACT_ID' => 9,
                                'SORT'       => 200,
                            ],
                            [
                                'CONTACT_ID' => 10,
                                'SORT'       => 400,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
                // Нужная вам логика обработки данных
                processData($result->data());
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting contact items for company: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.company.contact.items.set',
            {
                id: 32,
                items: [
                    {
                        CONTACT_ID: 8,
                        IS_PRIMARY: "Y",
                        SORT: 100,
                    },
                    {
                        CONTACT_ID: 9,
                        SORT: 200,
                    },
                    {
                        CONTACT_ID: 10,
                        SORT: 400,
                    }
                ],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.contact.items.set',
            [
                'id' => 32,
                'items' => [
                    [
                        'CONTACT_ID' => 8,
                        'IS_PRIMARY' => 'Y',
                        'SORT' => 100,
                    ],
                    [
                        'CONTACT_ID' => 9,
                        'SORT' => 200,
                    ],
                    [
                        'CONTACT_ID' => 10,
                        'SORT' => 400,
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1724139480.073569,
                "finish": 1724139481.016709,
                "duration": 0.9431400299072266,
                "processing": 0.4230809211730957,
                "date_start": "2024-08-20T09:38:00+02:00",
                "date_finish": "2024-08-20T09:38:01+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

Корневой элемент ответа. Содержит true в случае успеха

time
time

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

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "The parameter items must be array."
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

-

The parameter ownerEntityID is invalid or not defined

Передан id меньше или равен 0 или не передан вовсе

-

The parameter items must be array

В items передан не массив

ACCESS_DENIED

Access denied!

У пользователя нет прав на изменения компаний

-

Not found

Компания с переданным id не найдена

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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

Предыдущая
Получить набор контактов
Следующая
Обзор методов