Skip to end of metadata
Go to start of metadata

Описание

Добавление или обновление профиля.

Чтобы одновременно с импортом отправлять триггерную кампанию, используйте этот запрос.


URL-адрес

Метод: POST

Добавление или обновление профиля.

https://example.com/api/v1.1/profiles/import

Только обновление 

https://example.com/api/v1.1/profiles/update

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

  • При использовании JSON в теле запроса используйте заголовок Content-Type: application/json.
  • При использовании XML в теле запроса используйте заголовок Content-Type: application/xml.
ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
dataJSON object
{
    "_fname": "John",
    "_lname": "Doe"
}
ДаДанные о профиле
db_idint1ДаИдентификатор базы данных
skip_triggersbooltrueНетПропустить запуск триггеров
по умолчанию – false
skip_invalid_subscriptionsbooltrueНетПропустить невалидные подписки
по умолчанию – false
detect_geobooltrueНет

Включает автоопределение geo данных по полю _regip  или _ip в data

matchingstring

"email"

"email_profile"

"email_sub"

"phone"

"phone_sub"

"profile_id"

"push_sub"

"custom"

"custom_sub"

"email_phone"

"email_phone_sub"

Нет, если поиск

по email из профиля или подписок

Режим поиска подписчика.
По умолчанию - email. 

Для каждого типа матчинга в теле запроса необходимо передавать определенные поля. Подробнее об этих полях можно узнать здесь.

add_to_segmentsJSON список
[
	1,
	2
]
НетДобавление профиля в сегмент

remove_from_segments

JSON список
[
	1,
	2
]
НетУдаление профиля из сегмента

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

{
     "token": "91f1dfa81c264a938b475677c60ce967",
	 "db_id": 1,
     "matching": "email",
     "email": "example@example.com",
	 "detect_geo": true,
     "data": {
        "_status": 0,

        "_fname": "Olly",
        "_lname": "Lambert",

        "email": "example@example.com",
        "phones": ["+790000000000"],

        "subscriptions": [
            {
                "channel": "email",
                "email": "example@example.com",
                "priority": 0,             
                "resource_id": 1,
                "status": 0
            },
			{
                "channel": "sms",
                "phone": "+790000000000",
                "priority": 0,             
                "resource_id": 1,
                "status": 0
            },
			{
				"channel": "push",
				"subscription_id": "a81c264a938b475",
				"provider": "android-firebase", 
				"resource_id": 1,
				"status": 0
			}
        ],

        "_bdate": "1990-02-22T21:00:00Z",
        "_sex": 0,

		"_regdate": "2019-03-14T22:00:00Z",
		"_regip": "94.231.119.122",
		"_ip": "94.231.119.122",

        "_tz": "Europe/Moscow",
        "_postal_code": "390000",

		"_os": "Windows 10",
        "_browser": "Firefox",

        "_vendor": "form_#31",
 
        "custom_field": "custom_value"
	}
}

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

{
    "error": 0,
    "error_text": "",
    "profile_id": "54759eb3c090d83494e2d804"
}

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

<xml>
<token>e923e55afc3e4e07bd64afb2227f8a5c</token>
<db_id>8</db_id>
<matching>email</matching>
<detect_geo>true</detect_geo>
<format>xml</format>
<skip_triggers>false</skip_triggers>
<data>
		<email>example@example.org</email>
		<_fname>Leonid</_fname>
		<_lname>Spartov</_lname>
		<_bdate>1990-02-22T21:00:00Z</_bdate>
		<_sex>M</_sex>
		<_regip>94.231.119.122</_regip>
		<custom_string>value</custom_string>
		<custom_integer>42</custom_integer>
		<custom_date>1990-02-22T21:00:00Z</custom_date>
		<cutom_tags>tag1, tag2</cutom_tags>
		<custom_boolean>true</custom_boolean>
		<custom_enum>2</custom_enum>
		<custom_ip>94.231.119.122</custom_ip>
		<subscriptions>
			<subscription>
				<resource_id>3</resource_id>
				<channel>email</channel>
				<email>example@example.org</email>
				<status>0</status>
				<priority>0</priority>
			</subscription>
			<subscription>
				<resource_id>3</resource_id>
				<channel>sms</channel>
				<phone>71234567890</phone>
				<status>0</status>
				<priority>0</priority>
			</subscription>
			<subscription>
				<resource_id>3</resource_id>
				<channel>push</channel>
				<subscription_id>ONEOF77THESE11DAYS11dd1</subscription_id>
				<provider>Chrome</provider>
				<status>0</status>
				<priority>0</priority>
			</subscription>
		</subscriptions>
	</data>
</xml>

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

<result>
    <error>0</error>
    <error_text>Successful operation</error_text>
	<profile_id>c1are24fu213lwith21that2axe9<profile_id>
</result>

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
profile_idstringИдентификатор профиля
  • No labels