Связи сущностей

В данном разделе описываются доступные методы для работы со связями контактов, компаний, сделок и покупателей

Оглавление

Общая информация

Возможные связи различаются для разных типов сущностей

  • Для сделок доступны: контакты, компании, элементы списков
  • Для контактов доступны: компании, покупатели, элементы списков
  • Для компаний доступны: контакты, сделки, покупатели, элементы списков
  • Для покупателей доступны: контакты, компании, элементы списков

Список связанных сущностей

Метод

GET /api/v4/leads/{entity_id}/links

GET /api/v4/contacts/{entity_id}/links

GET /api/v4/companies/{entity_id}/links

GET /api/v4/customers/{entity_id}/links

Описание

Метод позволяет получить связанные сущности по ID основной сущности.

Ограничения

Метод доступен в соответствии с правами пользователя.

GET параметры

Параметр Тип данных Описание
filter object Фильтр
filter[to_entity_id] int Фильтр по ID связанной сущности, передается вместе с фильтром filter[to_entity_type]
filter[to_entity_type] string Фильтр по типу связанной сущности, передается вместе с фильтром filter[to_entity_id]
filter[to_catalog_id] int Фильтр по ID каталога связанной сущности

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа Условие
200 Запрос выполнен успешно
401 Пользователь не авторизован
400 Переданы некорректные данные. Подробности доступны в теле ответа

Параметры ответа

Метод возвращает коллекцию моделей связей. Рассмотрим ниже свойства моделей

Параметр Тип данных Описание
to_entity_id int ID связанной сущности
to_entity_type string Тип связанной сущности (leads, contacts, companies, customers, catalog_elements)
metadata object|null Метаданные связанной сущности
metadata[main_contact] bool Является ли привязанный контакт главным
metadata[quantity] int Количество прикрепленных элементов каталогов
metadata[catalog_id] int ID каталога

Пример ответа

        
{
    "_total_items": 4,
    "_links": {
        "self": {
            "href": "https://shard151.amocrm.ru/api/v4/leads/7593303/links?page=1&limit=50"
        }
    },
    "_embedded": {
        "links": [
            {
                "to_entity_id": 597393,
                "to_entity_type": "catalog_elements",
                "metadata": {
                    "quantity": 1,
                    "catalog_id": 4521
                }
            },
            {
                "to_entity_id": 11069775,
                "to_entity_type": "contacts",
                "metadata": {
                    "main_contact": true
                }
            },
            {
                "to_entity_id": 11271233,
                "to_entity_type": "contacts",
                "metadata": {
                    "main_contact": false
                }
            },
            {
                "to_entity_id": 11271229,
                "to_entity_type": "companies",
                "metadata": null
            }
        ]
    }
}
        
    

Привязка сущностей

Метод

POST /api/v4/leads/{entity_id}/link

POST /api/v4/contacts/{entity_id}/link

POST /api/v4/companies/{entity_id}/link

POST /api/v4/customers/{entity_id}/link

Описание

Метод позволяет прикреплять сущности к основной сущности.

Ограничения

Метод доступен в соответствии с правами пользователя.

Заголовок запроса

Content-Type: application/json

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

Параметр Тип данных Описание
to_entity_id int ID связанной сущности
to_entity_type string Тип связанной сущности (leads, contacts, companies, customers, catalog_elements)
metadata object|null Метаданные связанной сущности
metadata[catalog_id] int ID каталога
metadata[quantity] int Количество прикрепленных элементов каталогов
metadata[is_main] bool Является ли контакт главным
metadata[updated_by] int ID пользователя, от имени которого осуществляется прикрепление

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

        
[
    {
        "to_entity_id": 10,
        "to_entity_type": "catalog_elements",
        "metadata": {
            "quantity": 1,
            "catalog_id": 1026
        }
    },
    {
        "to_entity_id": 457282,
        "to_entity_type": "contacts",
        "metadata": {
            "is_main": true,
        }
    }
]
        
    

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа Условие
200 Сущности привязаны успешно
403 Не хватает прав для вызова данного метода
401 Пользователь не авторизован
400 Переданы некорректные данные. Подробности доступны в теле ответа

Параметры ответа

Метод возвращает коллекцию моделей привязанных сущностей. Параметры аналогичны тем, что возвращаются при запросе списка связей.

Пример ответа

        
{
    "_total_items": 2,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/leads/14158851/links"
        }
    },
    "_embedded": {
        "links": [
            {
                "entity_id": 14158851,
                "entity_type": "leads",
                "to_entity_id": 10,
                "to_entity_type": "catalog_elements",
                "metadata": {
                    "quantity": 1,
                    "catalog_id": 1026
                }
            },
            {
                "entity_id": 14158851,
                "entity_type": "leads",
                "to_entity_id": 457282,
                "to_entity_type": "contacts",
                "metadata": {
                    "main_contact": true
                }
            }
        ]
    }
}
        
    

Отвязка сущностей

Метод

POST /api/v4/leads/{entity_id}/unlink

POST /api/v4/contacts/{entity_id}/unlink

POST /api/v4/companies/{entity_id}/unlink

POST /api/v4/customers/{entity_id}/unlink

Описание

Метод позволяет открепить сущности у основной сущности.

Ограничения

Метод доступен в соответствии с правами пользователя.

Заголовок запроса

Content-Type: application/json

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

Параметр Тип данных Описание
to_entity_id int ID связанной сущности
to_entity_type string Тип связанной сущности (leads, contacts, companies, customers, catalog_elements)
metadata object|null Метаданные связанной сущности
metadata[catalog_id] int ID каталога
metadata[updated_by] int ID пользователя, от имени которого осуществляется открепление

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

        
[
    {
        "to_entity_id": 10,
        "to_entity_type": "catalog_elements",
        "metadata": {
            "catalog_id": 1026
        }
    },
    {
        "to_entity_id": 457282,
        "to_entity_type": "contacts",
    }
]
        
    

HTTP коды ответа

Код ответа Условие
204 Сущности отвязаны успешно
403 Не хватает прав для вызова данного метода
401 Пользователь не авторизован
400 Переданы некорректные данные. Подробности доступны в теле ответа

Параметры ответа

Метод не возвращает тело