метод REST scope: crm

crm.contact.company.add

Добавить компанию к указанному контакту

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

Описание

Метод crm.contact.company.add добавляет компанию к указанному контакту.

Параметры

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

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

Можно получить с помощью методов crm.contact.list или crm.contact.add

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

Объект формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n,
}

где:
- field_n — название поля
- value_n — значение поля

Список доступных полей описан ниже.

Параметр fields

COMPANY_ID crm_entity обязательный

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

Идентификатор можно получить с помощью метода crm.item.list по entityTypeId = 4

IS_PRIMARY boolean необязательный

Является ли привязка первичной. Возможные значения:
- 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":54,"fields":{"COMPANY_ID":32,"IS_PRIMARY":"Y","SORT":1000}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.company.add

Ответ

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.COMPANY_ID
- если переданный параметр fields.COMPANY_ID меньше или равен 0

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

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