Добавить связь
Описание
Создаёт связь между двумя профилями. При наличии идентичной связи между профилями запрос завершится ошибко й дубликации.
URL-адрес
Метод: POST.
https://example.com/api/v1.1/relations/attach
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
rel_id | int | 3 | Да | ID связи |
profile_a | bool | true | Да | Профиль базы данных А, к которому направлена связь |
profile_b | bool | true | Да | Профиль базы данных В, от которого направлена связь |
weights | object | {"user_like":2,"donate":343,"is_online":true} | Да | Свойства связи профилей |
Поиск профиля подписчика | ||||
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 |
Пример запроса
{
"token": "8d08f4ea57c74916909e9d324c20a6bc",
"rel_id":3,
"profile_a":{
"profile_id":"5d63dbdb439e7306b596c5d0"
},
"profile_b":{
"profile_id":"5d441038439e7363f3c26539"
},
"weights":{"user_like":2,"donate":343,"is_online":true}
}
Пример ответа
{
"error": 0,
"error_text": "",
"profile_a": "5c910f6bc484d023b1309bee",
"profile_b": "5c910938c484d023b1309bac",
"relation_id": 1
}
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
profile_a | string | Идентификатор профиля А |
profile_b | string | Идентификатор профиля B |
relation_id | 1 | Идентификатор связи |