Добавить контакт к сделке crm.deal.contact.add

Scope: crm

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

Метод crm.deal.contact.add добавляет контакт к указанной сделке.

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

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

Название
тип

Описание

id*
integer

Идентификатор сделки

Можно получить с помощью методов crm.deal.list или crm.deal.add

fields*
object

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

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

где:

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

Список доступных полей описан (подробное описание)

Параметр fields

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

Название
тип

Описание

CONTACT_ID*
crm_entity

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

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

IS_PRIMARY
char

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

  • Y — да
  • N — нет

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

SORT
integer

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

Примеры кода

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

Пример добавления связи сделка-контакт, где:

  • идентификатор сделки — 1875
  • идентификатор контакта — 55
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1875,"fields":{"CONTACT_ID":55,"IS_PRIMARY":"Y","SORT":1000}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.contact.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1875,"fields":{"CONTACT_ID":55,"IS_PRIMARY":"Y","SORT":1000},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.contact.add
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.contact.add',
        		{
        			id: 1875,
        			fields: {
        				CONTACT_ID: 55,
        				IS_PRIMARY: "Y",
        				SORT: 1000,
        			},
        		}
        	);
        
        	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.deal.contact.add',
                    [
                        'id' => 1875,
                        'fields' => [
                            'CONTACT_ID' => 55,
                            'IS_PRIMARY' => 'Y',
                            'SORT' => 1000,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding deal contact: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.deal.contact.add',
            {
                id: 1875,
                fields: {
                    CONTACT_ID: 55,
                    IS_PRIMARY: "Y",
                    SORT: 1000,
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.contact.add',
            [
            'id' => 1875,
            'fields' => [
                'CONTACT_ID' => 55,
                'IS_PRIMARY' => 'Y',
                'SORT' => 1000,
            ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1773222863,
                "finish": 1773222863.626254,
                "duration": 0.6262540817260742,
                "processing": 0,
                "date_start": "2026-03-11T12:54:23+03:00",
                "date_finish": "2026-03-11T12:54:23+03:00",
                "operating_reset_at": 1773223463,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

Корневой элемент ответа. Содержит:

  • true — связь добавлена
  • false — связь не добавлена, контакт уже связан со сделкой

time
time

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

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Not found."
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

-

The parameter 'ownerEntityID' is invalid or not defined.

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

-

The parameter 'fields' must be array.

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

-

Access denied.

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

ACCESS_DENIED

Access denied!

Нет прав на изменение сделки

-

Not found.

Сделка с переданным id не найдена

-

The parameter 'fields' is not valid.

Может возникать из-за нескольких причин:

  • если не передан обязательный параметр fields.CONTACT_ID
  • если переданный параметр fields.CONTACT_ID меньше или равен 0

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

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

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

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

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