Регистрация участника в программе лояльности

Описание

Регистрирует участника в программе лояльности. Перед регистрацией профиль ищется в базе по заданному способу сопоставления (email, телефон, идентификатор профиля или пользовательское поле).

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
loyalty_program_id	int	123	Да	Идентификатор программы лояльности
matching	string	"email"	Да	Способ поиска профиля: email, phone, profile_id, custom
registration_date	string	"2024-09-01T12:34:56Z"	Нет	Дата регистрации в формате RFC3339; если не указана — используется текущее время
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	Значение пользовательского поля

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

JSON

{
  "loyalty_program_id": 123,
  "matching": "email",
  "email": "user@example.com",
  "registration_date": "2024-09-01T12:34:56Z"
}

XML

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

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

JSON

{
  "error": 0,
  "error_text": "Successful operation",
  "profile_id": "123456"
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <profile_id>123456</profile_id>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
profile_id	string	Идентификатор профиля, зарегистрированного в программе лояльности