Удаление участника из программы лояльности
Описание
Удаляет участника из программы лояльности. Перед удалением профиль ищется по выбранному способу сопоставления: email, телефон, идентификатор профиля или пользовательское поле.
URL-адрес
Метод: POST
https://example.com/api/v1.1/loyalty/delete_member
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abc123def456" | Да | API-токен |
| loyalty_program_id | int | 123 | Да | Идентификатор программы лояльности |
| matching | string | "email" | Да | Способ поиска профиля: email, phone, profile_id, custom |
| 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
- XML
{
"token": "abc123def456",
"loyalty_program_id": 123,
"matching": "email",
"email": "user@example.com"
}
<xml>
<token>abc123def456</token>
<loyalty_program_id>123</loyalty_program_id>
<matching>email</matching>
<email>user@example.com</email>
</xml>
Пример ответа
- JSON
- XML
{
"error": 0,
"error_text": "Successful operation",
"profile_id": "123456"
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
<profile_id>123456</profile_id>
</xml>
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| profile_id | string | Идентификатор удалённого профиля |