Получить список связей профиля
Описание
Запрос возвращает список всех существующих связей для указанного профиля из базы данных A, включая идентификаторы связанных профилей, типы связей и их свойства.
URL-адрес
Метод: POST.
https://example.com/api/v1.1/relations/get
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
rel_id | int | 3 | Да | ID связи |
profile_id | string | "669e6968ebf4ac52b623a997" | Да, если не указан другой тип поиска | Идентификатор профиля из базы данных А для поиска |
Поиск профиля подписчика | ||||
string | "john@example.com" | "matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю | Email-адрес | |
phone | string | "+79000000000" | "matching":"phone" | Номер телефона |
profile_id | string | "abcdefghijklmnqrstuvwxyz" | "matching":"profile_id" | Идентификатор профиля |
field_name | string | "CRM_ID" | "matching":"custom" | Название кастомного поля профиля для поиска. |
field_value | int/string | "12345" | "matching":"custom" | Значение кастомного поля для поиска. подсказка Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2". |
resource_id | int | 24 | Нет | Идентификатор ресурса для поиска по email и phone |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"rel_id": 2,
"profile_id": "669e6968ebf4ac52b623a997"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<rel_id>2</rel_id>
<profile_id>669e6968ebf4ac52b623a997</profile_id>
</xml>