Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Описание

Массовое обновление данных профилей.

Если передать параметры объекта subscriptions status и priority со значением 0, то значение учитывается.
Чтобы не изменять и не обновлять значения этих параметров – не передавайте их, либо установите значения в -1.

URL-адрес

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
dataJSON array
[
    {
        "_fname": "John",
        "_lname": "Doe",
        "custom_id": "abcdefghijklmnqrstuvwxyz",
        "email": "john@example.com",
        "subscriptions": [
            {
                "channel": "email",
                "email_data": {
                    "email": "john@example.com"
                },
                "resource_id": 1,
                "status": "unsubscribed"
            }
        ]
    }
]
ДаДанные о профилях
db_idint1ДаИдентификатор базы данных
skip_invalid_subscriptionsbooltrueНетПропустить невалидные подписки
по умолчанию – false
Поиск профиля подписчика для обновления
matchingstring

"email"
"email_profile"
"phone"
"profile_id"
"custom"

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

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

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

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

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

{
    "data": [
        {
            "_fname": "John",
            "_lname": "Doe",
            "custom_id": "abcdefghijklmnqrstuvwxyz",
            "email": "jane@example.com",
            "subscriptions": [
                {
                    "channel": "email",
                    "email_data": {
                        "email": "john@example.com"
                    },
                    "resource_id": 1,
                    "status": "unsubscribed"
                }
            ]
        }
    ],
    "db_id": 1,
	"matching": "custom",
	"field_name": "CustomID",
    "field_value": 13,
    "skip_triggers": true,
    "token": "abcdefghijklmnqrstuvwxyz"
}




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

{
    "error": 0,
    "error_text": "Successful operation",
    "result": [
        {
            "error": 0,
            "error_text": "Successful operation",
            "profile_id": "abcdefghijklmnqrstuvwxyz"
        }
    ]
}

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

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



  • No labels