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

Привязать компанию к контакту

POST /v1/contacts/:id/companies

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

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

Параметры

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

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

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

Примеры

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

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

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

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

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts/2943/companies', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ companyId: 3101, 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/contacts/2943/companies', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ companyId: 3101, isPrimary: true, sort: 20 }),
})

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

Поля ответа

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

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

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

JSON
{
  "success": true,
  "data": [
    { "companyId": 3099, "sort": 10, "isPrimary": false, "roleId": 0 },
    { "companyId": 3101, "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 ОписаниеcompanyId не передан или не приводится к положительному целому числу, например "abc" или 0
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/companies/:id.
  • Роль не сохраняется. Поле roleId в теле принимается без ошибки, но не сохраняется: в ответе у новой связи roleId равен 0.
  • Сменить основную компанию или порядок. Для уже привязанных компаний используйте PUT /v1/contacts/:id/companies и передайте в items весь нужный состав: не переданные компании отвяжутся.

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