Задание на массовое добавление участников в программу лояльности

Описание

Запускает асинхронное задание на массовое добавление участников в программу лояльности. В ответ возвращается task_id, по которому можно отслеживать статус выполнения и получать результаты.

предупреждение

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

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

URL-адрес

Метод: POST

https://example.com/api/v1.1/loyalty/register_member_batch_task

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

Параметр	Тип	Пример	Обязательный	Описание
loyalty_program_id	int	123	Да	Идентификатор программы лояльности
matching	string	"email"	Да	Способ поиска профиля: email, phone, profile_id, custom
data	array	[{"email": "user@example.com"}]	Да	Массив участников для добавления
task_id	string	"199b9c75-c540-455e-9e38-3d54e51e1d7a"	Нет (требуется для следующих пачек)	Идентификатор существующего задания
next_key	string	"abc123"	Нет	Ключ пагинации для добавления следующей пачки

Массив data

Параметр	Тип	Пример	Обязательный	Описание
email	string	"user@example.com"	Да, если matching = email	Email для поиска профиля
phone	string	"+1234567890"	Да, если matching = phone	Телефон в международном формате
profile_id	string	"profile123"	Да, если matching = profile_id	Идентификатор профиля
field_name	string	"user_id"	Да, если matching = custom	Название пользовательского поля
field_value	string / int	"123456"	Да, если matching = custom	Значение пользовательского поля
registration_date	string	"2024-09-01T12:34:56Z"	Нет	Дата регистрации в формате RFC3339

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

JSON

{
  "loyalty_program_id": 123,
  "matching": "email",
  "data": [
    {
      "email": "user1@example.com",
      "registration_date": "2024-09-01T12:34:56Z"
    },
    {
      "email": "user2@example.com"
    }
  ]
}

XML

<xml>
  <loyalty_program_id>123</loyalty_program_id>
  <matching>email</matching>
  <data>
    <item>
      <email>user1@example.com</email>
      <registration_date>2024-09-01T12:34:56Z</registration_date>
    </item>
    <item>
      <email>user2@example.com</email>
    </item>
  </data>
</xml>

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

JSON

{
  "error": 0,
  "error_text": "Successful operation",
  "task_id": "199b9c75-c540-455e-9e38-3d54e51e1d7a"
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <task_id>199b9c75-c540-455e-9e38-3d54e51e1d7a</task_id>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки (0 — успешная операция)
error_text	string	Текст ошибки
task_id	string	Идентификатор асинхронного задания