Для AI-агентов: markdown этой страницы — /docs-content/entities/leads/contacts-create.md индекс документации — /llms.txt

Привязать контакт к лиду

POST /v1/leads/:id/contacts

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

Чтобы задать весь состав контактов одним вызовом, используйте PUT /v1/leads/:id/contacts.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID лида. Список: GET /v1/leads

Поля запроса (body)

Поле Тип Обяз. Описание
ПолеcontactId Типnumber Обяз.да ОписаниеID контакта. Список: GET /v1/contacts. Принимается и строка из цифр, например "2939"
ПолеisPrimary Типboolean Обяз.нет ОписаниеСделать контакт основным. Прежний основной контакт теряет признак. Первый контакт лида становится основным при любом значении
Полеsort Типnumber Обяз.нет ОписаниеПорядок контакта в списке. Без значения связь встаёт в конец списка

Примеры

curl — личный ключ

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/leads/1001321/contacts" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "contactId": 2939, "isPrimary": true, "sort": 20 }'

curl — OAuth-приложение

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/leads/1001321/contacts" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "contactId": 2939, "isPrimary": true, "sort": 20 }'

JavaScript — личный ключ

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/1001321/contacts', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ contactId: 2939, isPrimary: true, sort: 20 }),
})

const { success, data } = await res.json()
console.log('Контактов у лида:', data.length)

JavaScript — OAuth-приложение

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/1001321/contacts', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ contactId: 2939, isPrimary: true, sort: 20 }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеВсе связи лида после привязки, в порядке sort
Полеdata[].contactId Типnumber ОписаниеID контакта. Получить контакт: GET /v1/contacts/:id
Полеdata[].isPrimary Типboolean ОписаниеОсновной контакт лида. true ровно у одной связи
Полеdata[].sort Типnumber ОписаниеПорядок контакта в списке
Полеdata[].roleId Типnumber ОписаниеРоль контакта в лиде. Методы связей её не сохраняют

Пример ответа

К лиду с одним контактом привязан второй, основным стал новый:

JSON
{
  "success": true,
  "data": [
    { "contactId": 2937, "sort": 10, "isPrimary": false, "roleId": 0 },
    { "contactId": 2939, "sort": 20, "isPrimary": true, "roleId": 0 }
  ]
}

Пример ответа при ошибке

409 — контакт уже привязан к этому лиду:

JSON
{
  "success": false,
  "error": {
    "code": "RELATION_ALREADY_EXISTS",
    "message": "This binding already exists"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не является положительным целым числом
HTTP400 КодMISSING_REQUIRED_FIELDS ОписаниеcontactId не передан или не является положительным целым числом
HTTP404 КодENTITY_NOT_FOUND ОписаниеЛида с таким id нет
HTTP409 КодRELATION_ALREADY_EXISTS ОписаниеКонтакт уже привязан к этому лиду
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеК ключу не привязаны токены Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает в режиме только чтения. Для привязки нужен ключ с правом записи
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов. Повторите после срока из заголовка Retry-After
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен. Повторите запрос позже

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Существование контакта не проверяется. ID, которого нет среди контактов, привязывается без ошибки и появляется в списке связей лида. Перед привязкой проверьте контакт через GET /v1/contacts/:id.
  • Роль не сохраняется. Поле roleId в теле принимается без ошибки, но не сохраняется: в ответе у новой связи roleId равен 0.
  • Основной контакт и порядок меняет замена. Основной контакт или порядок уже привязанных контактов меняйте через PUT /v1/leads/:id/contacts и передавайте в items весь нужный состав: контакты, которых нет в items, отвяжутся. PATCH /v1/leads/:id с contactId уже привязанного контакта отвечает 200, но основной контакт не меняет.

Смотрите также