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

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

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

Scope: crm

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

DEPRECATED

Развитие метода остановлено. Используйте метод REST 3.0 crm.deal.addfieldvalue с полем contactsId. Основной контакт назначает метод crm.deal.setprimarycontact. Позицию контакта SORT метод REST 3.0 не принимает, для нее используйте этот метод.

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

Метод работает с одной привязкой и не затрагивает остальные контакты сделки. Чтобы задать весь набор контактов сразу, используйте crm.deal.contact.items.set. Как устроена связь и как выбрать метод, описано в обзоре раздела.

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

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

Название
тип

Описание

id*
integer

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

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

fields*
object

Объект с полями привязки контакта к сделке (подробное описание)

Параметр fields

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

Название
тип

Описание

CONTACT_ID*
integer

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

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

Метод не проверяет, что контакт существует: с несуществующим идентификатором он создаст привязку и вернет true

IS_PRIMARY
char

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

  • Y — да
  • N — нет

Если у сделки нет основного контакта, добавляемый контакт станет основным при любом значении. Иначе Y делает контакт основным и снимает флаг с прежнего, а N или отсутствие параметра оставляют основной контакт прежним.

Идентификатор основного контакта записывается в поле сделки CONTACT_ID

SORT
integer

Индекс сортировки. Задает порядок контакта в карточке сделки.

Если не передан, подставляется максимальный SORT среди привязок сделки плюс 10

Примеры кода

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

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

  • идентификатор сделки — 1875
  • идентификатор контакта — 55
  • признак основного контакта — IS_PRIMARY = Y
  • индекс сортировки — 1000
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
// 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<boolean>({
    method: 'crm.deal.contact.add',
    params: {
      id: 1875,
      fields: {
        CONTACT_ID: 55,
        IS_PRIMARY: 'Y',
        SORT: 1000,
      },
    },
    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('Contact linked to deal:', 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 addDealContact() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.deal.contact.add',
        params: {
          id: 1875,
          fields: {
            CONTACT_ID: 55,
            IS_PRIMARY: 'Y',
            SORT: 1000,
          },
        },
        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('Contact linked to deal:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addDealContact)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.deal.contact.add(
        bitrix_id=1875,
        fields={
            "CONTACT_ID": 55,
            "IS_PRIMARY": "Y",
            "SORT": 1000,
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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();

    print_r($result);
} catch (Throwable $e) {
    echo $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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.deal.contact.add", b24.Params{
	"id": 1875,
	"fields": b24.Params{
		"CONTACT_ID": 55,
		"IS_PRIMARY": "Y",
		"SORT":       1000,
	},
})
if err != nil {
	return fmt.Errorf("crm.deal.contact.add: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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 — связь не добавлена, контакт уже связан со сделкой. Существующая привязка не меняется, переданные IS_PRIMARY и SORT игнорируются. Чтобы изменить их, используйте crm.deal.contact.items.set

time
time

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

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

HTTP-статус: 400, 403

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

Пустое значение

The parameter 'ownerEntityID' is invalid or not defined.

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

400

Пустое значение

The parameter 'fields' must be array.

Параметр fields не передан или передан не объект

400

Пустое значение

Access denied.

Сделка с переданным id не найдена, и у пользователя нет права «изменения» сделок

403

ACCESS_DENIED

Access denied!

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

400

Пустое значение

Not found.

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

400

Пустое значение

[Контакт #55] У Вас нет прав на просмотр этого элемента

У пользователя нет права «чтения» контакта из fields.CONTACT_ID. В тексте подставляется идентификатор контакта

400

Пустое значение

The parameter 'fields' is not valid.

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

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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