Добавить привязку контакта к лиду crm.lead.contact.add

Scope: crm

Кто может выполнять метод: любой пользователь

Метод добавляет привязку контакта к указанному лиду.

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

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

Название
тип

Описание

id*
integer

Идентификатор лида, к которому нужно добавить контакт. Идентификатор лида можно получить методом получения списка лидов

fields*
object

Значения полей (подробное описание приведено ниже) для добавления контакта к лиду в виде структуры:

fields:
            {
                "CONTACT_ID": "значение",
                "SORT": "значение",
                "IS_PRIMARY": "значение"
            }

Параметр fields

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

Название
тип

Описание

CONTACT_ID*
integer

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

SORT
integer

Индекс сортировки. По умолчанию устанавливается 10

IS_PRIMARY
string

Флаг первичного контакта

  • Y — да
  • N — нет

По умолчанию устанавливается N

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1,"fields":{"CONTACT_ID":1010,"SORT":10,"IS_PRIMARY":"Y"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.contact.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1,"fields":{"CONTACT_ID":1010,"SORT":10,"IS_PRIMARY":"Y"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.lead.contact.add
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.lead.contact.add',
        		{
        			id: 1,
        			fields: {
        				'CONTACT_ID': 1010,
        				'SORT': 10,
        				'IS_PRIMARY': 'Y'
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if (result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.lead.contact.add',
                    [
                        'id' => 1,
                        'fields' => [
                            'CONTACT_ID' => 1010,
                            'SORT' => 10,
                            'IS_PRIMARY' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding lead contact: ' . $e->getMessage();
        }
        
BX24.callMethod(
                "crm.lead.contact.add",
                {
                    id: 1,
                    fields:
                    {
                        "CONTACT_ID": 1010,
                        "SORT": 10,
                        "IS_PRIMARY": "Y"
                    }
                },
                result => {
                    if (result.error())
                        console.error(result.error());
                    else
                        console.dir(result.data());
                }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.lead.contact.add',
            [
                'id' => 1,
                'fields' =>
                [
                    'CONTACT_ID' => 1010,
                    'SORT' => 10,
                    'IS_PRIMARY' => 'Y'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1715091541.642592,
                "finish": 1715091541.730599,
                "duration": 0.08800697326660156,
                "date_start": "2024-05-03T17:19:01+03:00",
                "date_finish": "2024-05-03T17:19:01+03:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

Результат операции

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

ACCESS_DENIED

Недостаточно прав

NOT_FOUND

Элемент не найден

Не переданы обязательные поля

Другие ошибки (например, фатальные ошибки)

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

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

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

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

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