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

Scope: crm

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

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

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

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

Название
тип

Описание

id*
integer

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

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

items*
object[]

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

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

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

Название `тип`	Описание
COMPANY_ID* `crm_entity`	Идентификатор компании, который будет привязан к контакту. Идентификатор можно получить с помощью метода crm.item.list по `entityTypeId = 4`
IS_PRIMARY `boolean`	Является ли привязка первичной. Возможные значения: `Y` — да `N` — нет Если нет привязки с `IS_PRIMARY = Y`, то она выставляется у первой привязки в `items`. Если передано несколько привязок с `IS_PRIMARY = Y`, то первичной будет считаться первая привязка с `IS_PRIMARY = Y`
SORT `integer`	Индекс сортировки. По умолчанию `i + 10`, где `i` — максимальный индекс сортировки у существующих и переданных привязок для текущего контакта или `0` в случае, если `SORT` не передан ни у одной из привязок и если у контакта отсутствуют привязки. Если передана уже существующая привязка без параметра `SORT`, то значение по умолчанию не выставится (значение останется тем же)

Примеры кода

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

Установить у контакта с id = 82 следующие привязанные компании:

компания с id = 8, сделать ее первичной и установить SORT = 100
компания с id = 9, установить SORT = 200
компания с id = 10, установить SORT = 400

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":82,"items":[{"COMPANY_ID":8,"IS_PRIMARY":"Y","SORT":100},{"COMPANY_ID":9,"SORT":200},{"COMPANY_ID":10,"SORT":400}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.company.items.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":82,"items":[{"COMPANY_ID":8,"IS_PRIMARY":"Y","SORT":100},{"COMPANY_ID":9,"SORT":200},{"COMPANY_ID":10,"SORT":400}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.company.items.set

try
        {
        	const response = await $b24.callMethod(
        		'crm.contact.company.items.set',
        		{
        			id: 82,
        			items: [
        				{
        					COMPANY_ID: 8,
        					IS_PRIMARY: "Y",
        					SORT: 100,
        				},
        				{
        					COMPANY_ID: 9,
        					SORT: 200,
        				},
        				{
        					COMPANY_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.contact.company.items.set',
                    [
                        'id'    => 82,
                        'items' => [
                            [
                                'COMPANY_ID' => 8,
                                'IS_PRIMARY' => 'Y',
                                'SORT'       => 100,
                            ],
                            [
                                'COMPANY_ID' => 9,
                                'SORT'       => 200,
                            ],
                            [
                                'COMPANY_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 company items for contact: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.contact.company.items.set',
            {
                id: 82,
                items: [
                    {
                        COMPANY_ID: 8,
                        IS_PRIMARY: "Y",
                        SORT: 100,
                    },
                    {
                        COMPANY_ID: 9,
                        SORT: 200,
                    },
                    {
                        COMPANY_ID: 10,
                        SORT: 400,
                    }
                ],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.company.items.set',
            [
                'id' => 82,
                'items' => [
                    [
                        'COMPANY_ID' => 8,
                        'IS_PRIMARY' => 'Y',
                        'SORT' => 100,
                    ],
                    [
                        'COMPANY_ID' => 9,
                        'SORT' => 200,
                    ],
                    [
                        'COMPANY_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	Превышен лимит на интенсивность запросов
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Получить набор компаний, связанных с указанным контактом

Очистить набор компаний, связанных с указанным контактом

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

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

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

Примеры кодаПримеры кода

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

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

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

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

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

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