Для AI-агентов: markdown этой страницы — /docs-content/entities/contacts/companies-set.md индекс документации — /llms.txt
Заменить компании контакта
PUT /v1/contacts/:id/companies
Задаёт весь состав компаний контакта одним вызовом: привязывает компании из списка и отвязывает все остальные.
Чтобы добавить одну компанию и не отвязывать остальные, используйте POST /v1/contacts/:id/companies.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрid (path) |
Типnumber | Обяз.да | ОписаниеID контакта. Список: GET /v1/contacts |
Поля запроса (body)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
Полеitems |
Типarray | Обяз.да | ОписаниеНовый состав компаний контакта, включая уже привязанные компании, которые должны остаться. Компании, которых нет в массиве, отвязываются. Пустой массив [] отвязывает все компании |
Полеitems[].companyId |
Типnumber | Обяз.да | ОписаниеID компании. Список: GET /v1/companies. Принимается и строка из цифр, например "3099" |
Полеitems[].isPrimary |
Типboolean | Обяз.нет | ОписаниеОсновная компания контакта. Если ни у одного элемента нет true, основной становится первый элемент массива, даже если у него не наименьший sort. Если true у нескольких, основной становится первый из них. Чтобы основная компания не сменилась, передайте ей isPrimary: true |
Полеitems[].sort |
Типnumber | Обяз.нет | ОписаниеПорядок компании в списке. Без значения номер присваивается по месту элемента в массиве |
Примеры
curl — личный ключ
curl -X PUT "https://vibecode.bitrix24.tech/v1/contacts/2943/companies" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"items": [
{ "companyId": 3103, "sort": 10 },
{ "companyId": 3099, "isPrimary": true, "sort": 20 }
]
}'
curl — OAuth-приложение
curl -X PUT "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 '{
"items": [
{ "companyId": 3103, "sort": 10 },
{ "companyId": 3099, "isPrimary": true, "sort": 20 }
]
}'
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts/2943/companies', {
method: 'PUT',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
items: [
{ companyId: 3103, sort: 10 },
{ companyId: 3099, isPrimary: true, sort: 20 },
],
}),
})
const { success, data } = await res.json()
console.log('Компаний у контакта:', data.length)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts/2943/companies', {
method: 'PUT',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
items: [
{ companyId: 3103, sort: 10 },
{ companyId: 3099, isPrimary: true, sort: 20 },
],
}),
})
const { success, data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata |
Типarray | ОписаниеВсе связи контакта после замены, в порядке sort. После "items": [] — пустой массив |
Полеdata[].companyId |
Типnumber | ОписаниеID компании. Получить компанию: GET /v1/companies/:id |
Полеdata[].isPrimary |
Типboolean | ОписаниеОсновная компания контакта. true ровно у одной связи |
Полеdata[].sort |
Типnumber | ОписаниеПорядок компании в списке |
Полеdata[].roleId |
Типnumber | ОписаниеРоль связи. Методы связей её не сохраняют |
Пример ответа
{
"success": true,
"data": [
{ "companyId": 3103, "sort": 10, "isPrimary": false, "roleId": 0 },
{ "companyId": 3099, "sort": 20, "isPrimary": true, "roleId": 0 }
]
}
Пример ответа при ошибке
400 — в теле нет массива items:
{
"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, где 0 — номер элемента |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеУ элемента items нет companyId или он не приводится к положительному целому числу, например 0 или "abc". Сообщение — items[0] requires 'companyId', где 0 — номер элемента |
| 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/companies/:id. - Роль не сохраняется. Поле
roleIdв элементеitemsпринимается без ошибки, но не сохраняется: в ответеroleIdравен0.