Удалить контакт из указанной компании crm.company.contact.delete
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом «Изменение» компаний и правом «Чтение» контакта, который удаляется из привязок
Метод crm.company.contact.delete удаляет контакт из указанной компании.
Удаляется только связь компании с контактом — сам контакт остается в CRM. Чтобы отвязать от компании сразу все контакты, используйте crm.company.contact.items.delete. Как устроен объект привязки, описано в обзоре раздела.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор компании. Должен быть больше Идентификатор можно получить с помощью метода crm.item.list по |
|
fields* |
Объект с информацией о том, какой контакт нужно удалить из привязок. Содержит единственный ключ |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
CONTACT_ID* |
Идентификатор контакта, который нужно удалить из привязок компании. Должен быть больше Идентификаторы привязанных контактов можно получить методом crm.company.contact.items.get |
Удалить первичную привязку
Флаг IS_PRIMARY относится к контакту: он означает, что компания из привязки для контакта основная.
Если удалить такую привязку, поле контакта COMPANY_ID переключится на другую его компанию с наименьшим идентификатором или очистится, когда у контакта нет других компаний. Флаг IS_PRIMARY в оставшихся привязках контакта при этом не переключается в Y — сделать компанию основной заново можно методом crm.company.contact.add.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":32,"fields":{"CONTACT_ID":54}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.contact.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":32,"fields":{"CONTACT_ID":54},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.company.contact.delete
// 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.delete',
params: {
id: 32,
fields: {
CONTACT_ID: 54,
},
},
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 removed from 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 deleteCompanyContact() {
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.delete',
params: {
id: 32,
fields: {
CONTACT_ID: 54,
},
},
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 removed from company:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteCompanyContact)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.company.contact.delete(
bitrix_id=32,
fields={
"CONTACT_ID": 54,
},
).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.delete',
[
'id' => 32,
'fields' => [
'CONTACT_ID' => 54,
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting contact from company: ' . $e->getMessage();
}
BX24.callMethod(
'crm.company.contact.delete',
{
id: 32,
fields: {
CONTACT_ID: 54,
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.company.contact.delete',
[
'id' => 32,
'fields' => [
'CONTACT_ID' => 54,
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.company.contact.delete", b24.Params{
"id": 32,
"fields": b24.Params{
"CONTACT_ID": 54,
},
})
if err != nil {
return fmt.Errorf("crm.company.contact.delete: %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": 1724072653.79827,
"finish": 1724072717.749956,
"duration": 63.95168590545654,
"processing": 63.63148093223572,
"date_start": "2024-08-19T15:04:13+02:00",
"date_finish": "2024-08-19T15:05:17+02:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит:
|
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "The parameter 'ownerEntityID' is invalid or not defined."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
Пустое значение |
|
Передан |
|
Пустое значение |
|
В |
|
|
|
У пользователя нет прав на изменение компаний или на чтение контакта |
|
Пустое значение |
|
Компания с переданным |
|
Пустое значение |
|
Может возникать в нескольких случаях:
|
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Контакты компаний: обзор методов
- Добавить контакт к указанной компании crm.company.contact.add
- Получить набор контактов, связанных с указанной компанией crm.company.contact.items.get
- Установить набор контактов, связанных с указанной компанией crm.company.contact.items.set
- Очистить набор контактов, связанных с указанной компанией crm.company.contact.items.delete
- Получить описание полей для связи компания-контакт crm.company.contact.fields