Skip to end of metadata
Go to start of metadata

Описание

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

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

В одном запросе не рекомендуется:

  • передавать более 10 000 профилей;
  • передавать более 10 Мб данных. Можно передавать больший объем в несколько потоков. 

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-адрес. Должен быть передан в элементе массива data.
phonestring"+79000000000""matching":"phone"Номер телефона. 
profile_idstring
"abcdefghijklmnqrstuvwxyz"
"matching":"profile_id"Идентификатор профиля
field_namestring

"CRM_ID"

"matching":"custom"Название кастомного поля профиля для поиска. Данное поле должно присутствовать в элементе массива data.
resource_idint24Нет

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

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

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

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

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

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

ПараметрТипОписание
errorintКод ошибки, для всего запроса
error_textstringТекст ошибки, для всего запроса
dataarray of objectРезультаты обновления по профилям
data.errorintКод ошибки, для профиля
data.error_textstringТекст ошибки, для для профиля
data.profile_idstringИдентификатор профиля



  • No labels