Перейти к основному содержимому

Добавить связь

Описание

Создаёт связь между двумя профилями. При наличии идентичной связи между профилями запрос завершится ошибкой дубликации.

URL-адрес

Метод: POST.

https://example.com/api/v1.1/relations/attach

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
rel_idint3ДаID связи
profile_abooltrueДаПрофиль базы данных А, к которому направлена связь
profile_bbooltrueДаПрофиль базы данных В, от которого направлена связь
weightsobject
{"user_like":2,"donate":343,"is_online":true}
ДаСвойства связи профилей
Поиск профиля подписчика
emailstring"john@example.com""matching":"email" - по профилю и подпискам

"matching":"email_profile" - только по профилю
Email-адрес
phonestring"+79000000000""matching":"phone"Номер телефона
profile_idstring"abcdefghijklmnqrstuvwxyz""matching":"profile_id"Идентификатор профиля
field_namestring"CRM_ID""matching":"custom"Название кастомного поля профиля для поиска.
field_valueint/string"12345""matching":"custom"

Значение кастомного поля для поиска.

подсказка

Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2".

resource_idint24НетИдентификатор ресурса для поиска по email и phone

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

{
"token": "abcdefghijklmnqrstuvwxyz",
"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
}

Возвращаемые параметры

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
profile_astringИдентификатор профиля А
profile_bstringИдентификатор профиля B
relation_id1Идентификатор связи