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

Profile data object

Используется в API запросах, связанных с импортом подписчиков в базы данных. В объекте передаются значения полей базы и подписки.

Информацию о всех полях конретной базы данных можно получить по запросу к api/v1.1/databases/fields_get/.

Общая информация о базах данных и используемых полях доступна в пользовательской документации.

JSON

{
"data": {
"_regcountry": "US",
"_regcity": "New York",
"_regip": "94.231.119.122",
"_regurl": "www.example.com",
"_regdate": "2019-03-14T22:00:00Z",
"_bdate": "1990-02-22T21:00:00Z",
"_browser": "Thunderbird",
"_city": "Ryazan",
"_country": "RU",
"_fname": "Olly",
"_ip": "94.231.119.122",
"_lname": "Lambert",
"_postal_code": "390000",
"_region": "Ryazan Oblast",
"_vendor": "form_#31",
"_sex": 0,
"_status": 0,
"_tz": "Europe/Moscow",
"email": "example@altcraft.com",
"phones": [
"+79000000000"
],
"custom_field": "custom_value",
"subscriptions": [
{
"channel": "email",
"email": "boris.yudaev@altcraft.com",
"priority": 0,
"resource_id": 1,
"status": 0
}
]
}
}

Описание

ПараметрТипПримерОписание
bdatestring1990-02-22T21:00:00ZДата рождения в формате RFC 3339
browserstringFirefoxБраузер
_citystringRyazanГород
_countrystringRUСтрана в формате TLD
_fnamestringOllyИмя
_ipstring94.231.119.122IP адрес *
_lnamestringLambertФамилия
_postal_codeint390000Почтовый индекс
_regionstringRyazan OblastРегион
_statusint0Глобальный статус подписки
_tzstringEurope/MoscowЧасовой пояс
emailstringexample@altcraft.comАдрес электронной почты
phonesJSON array["+79000000000"]Номера телефонов
subscriptionsJSON array["",""]Подписки профиля
custom_field*custom_valueДополнительные поля базы данных.

Возможно функциональное обновление полей. Для этого необходимо указать действие (action) и значение (value).

Пример запроса для увеличения значения поля:
"custom_field": {
   "action": "incr",
   "value": 1000
}
_regcountrystringUSСтрана регистрации в формате TLD
_regcitystringNew YorkГород регистрации
_regipstring94.231.119.122IP регистрации
_regurlstringwww.example.orgURL регистрации
_regdatestring2018-02-22T21:00:00ZДата регистрации в формате RFC 3339
_sexint0Идентификатор Пола, указывается согласно Список гендерных идентификаций
_vendorstringform#33Форма сбора данных клиентов

* При передаче в запросе на импорт IP адреса в формате IPv4 платформа автоматически определяет местоположение подписчика и записывает следующие системные поля данных:

{
"_ip": "94.231.119.122", // уже добавляется само по себе
"_lat": 54.6197, // географическая широта
"_lon": 39.74, // географическая долгота
"_postal_code": "390000",
"_region": "Ryazanskaya Oblast",
"_country": "RU",
"_city": "Ryazan",
"_tz": "Europe/Moscow"
}