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

Заменить контакты лида

PUT /v1/leads/:id/contacts

Задаёт весь состав контактов лида одним вызовом: привязывает контакты из списка и отвязывает все остальные.

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

Параметры

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

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

Поле Тип Обяз. Описание
Полеitems Типarray Обяз.да ОписаниеНовый состав контактов лида, включая уже привязанные контакты, которые должны остаться. Контакты, которых нет в массиве, отвязываются. Пустой массив [] отвязывает все контакты
Полеitems[].contactId Типnumber Обяз.да ОписаниеID контакта. Список: GET /v1/contacts
Полеitems[].isPrimary Типboolean Обяз.нет ОписаниеОсновной контакт лида. Если ни у одного элемента нет true, основным становится первый элемент массива. Если true у нескольких элементов — первый из них
Полеitems[].sort Типnumber Обяз.нет ОписаниеПорядок контакта в списке. Без значения номер ставится по месту элемента: первому 10, второму 20

Примеры

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

Terminal
curl -X PUT "https://vibecode.bitrix24.tech/v1/leads/1001321/contacts" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "contactId": 2941, "sort": 10 },
      { "contactId": 2937, "isPrimary": true, "sort": 20 }
    ]
  }'

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

Terminal
curl -X PUT "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 '{
    "items": [
      { "contactId": 2941, "sort": 10 },
      { "contactId": 2937, "isPrimary": true, "sort": 20 }
    ]
  }'

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/1001321/contacts', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { contactId: 2941, sort: 10 },
      { contactId: 2937, 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: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { contactId: 2941, sort: 10 },
      { contactId: 2937, isPrimary: true, sort: 20 },
    ],
  }),
})

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

Поля ответа

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

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

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

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

400 — в теле нет массива items:

JSON
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "items must be an array (use [] to unlink all)"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не является положительным целым числом
HTTP400 КодINVALID_PARAMS Описаниеitems не передан или не является массивом
HTTP400 КодINVALID_PARAMS ОписаниеЭлемент items не является объектом. Сообщение начинается с номера элемента: items[0] must be an object
HTTP400 КодINVALID_PARAMS ОписаниеУ элемента items нет contactId или contactId не является положительным целым числом. Сообщение называет номер элемента: items[0] requires 'contactId'
HTTP404 КодENTITY_NOT_FOUND ОписаниеЛида с таким id нет
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 в элементе items принимается без ошибки, но не сохраняется: в ответе у новой связи roleId равен 0.

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