crm.company.contact.add
Добавить контакт к указанной компании
Описание
Метод crm.company.contact.add добавляет контакт к указанной компании.
Параметры
id
integer
обязательный
Идентификатор компании.
Можно получить с помощью методов crm.company.list или crm.company.add
fields
object
обязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
где:
- field_n — название поля
- value_n — значение поля
Список доступных полей описан ниже
Параметр fields
CONTACT_ID
crm_entity
обязательный
Идентификатор контакта, который будет привязан к компании.
Идентификатор можно получить с помощью метода crm.item.list по entityTypeId = 3
IS_PRIMARY
char
необязательный
Является ли привязка первичной. Возможные значения:
- Y — да
- N — нет
У первого добавленного элемента IS_PRIMARY по умолчанию равен Y
Передача IS_PRIMARY = Y у новой и не первой привязки перетирает существующую первичную привязку
SORT
integer
необязательный
Индекс сортировки.
По умолчанию i + 10, где i — максимальный индекс сортировки у существующих привязок для текущей компании или 0, если таких нет
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":32,"fields":{"CONTACT_ID":54,"IS_PRIMARY":"Y","SORT":1000}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.contact.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":32,"fields":{"CONTACT_ID":54,"IS_PRIMARY":"Y","SORT":1000},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.company.contact.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'crm.company.contact.add',
params: {
id: 32,
fields: {
CONTACT_ID: 54,
IS_PRIMARY: 'Y',
SORT: 1000,
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Contact added to company:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addCompanyContact() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.company.contact.add',
params: {
id: 32,
fields: {
CONTACT_ID: 54,
IS_PRIMARY: 'Y',
SORT: 1000,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Contact added to company:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCompanyContact)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.company.contact.add(
bitrix_id=32,
fields={
"CONTACT_ID": 54,
"IS_PRIMARY": "Y",
"SORT": 1000,
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.company.contact.add',
[
'id' => 32,
'fields' => [
'CONTACT_ID' => 54,
'IS_PRIMARY' => 'Y',
'SORT' => 1000,
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding company contact: ' . $e->getMessage();
}
BX24.callMethod(
'crm.company.contact.add',
{
id: 32,
fields: {
CONTACT_ID: 54,
IS_PRIMARY: "Y",
SORT: 1000,
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.company.contact.add',
[
'id' => 32,
'fields' => [
'CONTACT_ID' => 54,
'IS_PRIMARY' => 'Y',
'SORT' => 1000,
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.company.contact.add", b24.Params{
"id": 32,
"fields": b24.Params{
"CONTACT_ID": 54,
"IS_PRIMARY": "Y",
"SORT": 1000,
},
})
if err != nil {
return fmt.Errorf("crm.company.contact.add: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2024-08-19T13:47:08+02:00",
"date_finish": "2024-08-19T13:47:08+02:00"
}
}
Возвращаемые данные
result
boolean
Корневой элемент ответа. Содержит:
- true — в случае успеха
- false — в случае неудачи, если контакт, который вы пытаетесь добавить, уже есть в привязках
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "The parameter 'ownerEntityID' is invalid or not defined."
}
| Код | Описание | Значение |
|---|---|---|
| — | The parameter 'ownerEntityID' is invalid or not defined |
Передан id меньше или равен 0 или не передан вовсе |
| — | The parameter 'fields' must be array |
В fields передан не объект |
ACCESS_DENIED |
Access denied! |
У пользователя нет прав на изменение компании |
| — | Not found |
Компания с переданным id не найдена |
| — | The parameter 'fields' is not valid |
Может возникать из-за нескольких причин: - если не передан обязательный параметр fields.CONTACT_ID- если переданный параметр fields.CONTACT_ID меньше или равен 0 |

