метод REST scope: crm

crm.company.contact.delete

Удалить контакт из указанной компании

Кто может выполнять: пользователь с правом «Изменение» компаний

Описание

Метод crm.company.contact.delete удаляет контакт из указанной компании.

Параметры

id integer обязательный

Идентификатор компании.

Идентификатор можно получить с помощью методов crm.company.list или crm.company.add

fields object обязательный

Объект с информацией о том, какой контакт необходимо удалить из привязок.

Содержит единственный ключ CONTACT_ID

fields.CONTACT_ID crm_entity обязательный

Идентификатор контакта, который необходимо удалить из привязок

Примеры запроса

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

Ответ

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 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 'item' must be array. В fields передан не объект
ACCESS_DENIED Access denied! У пользователя нет прав на изменение компании
Not found. Компания с переданным id не найдена
The parameter 'fields' is not valid. Может возникать в нескольких случаях:
- если не передан обязательный параметр fields.CONTACT_ID
- если переданный параметр fields.CONTACT_ID меньше или равен 0

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.