Отвязать промокод от профиля
Описание
Отвязать промокод от профиля.
Если для промокода не выбрано уникальное значение и по нему найдется более, чем один профиль, то API вернет ошибку.
URL-адрес
Метод: POST
https://example.com/api/v1.1/promocodes/detach
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| code | string | "CODE-12345" | Нет | Код |
| db_id | int | 1 | Да | Идентификатор базы данных |
| format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
| loyalty_id | int | 1 | Да | Идентификатор программы лояльности |
| Поиск профиля подписчика | ||||
| matching | string | "email" "email_profile" "phone" "profile_id" "custom" | Нет, если поиск по email из профиля или подписок | Режим поиска подписчика (по умолчанию - email) |
| string | "john@example.com" | "matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю | Email-адрес | |
| phone | string | "+79000000000" | "matching":"phone" | Номер телефона |
| profile_id | string | "abcdefghijklmnqrstuvwxyz" | "matching":"profile_id" | Идентификатор профиля |
| field_name | string | "matching":"custom" | Название поля для поиска | |
| field_value | string/int | "matching":"custom" | Значение поля для поиска | |
| resource_id | int | 24 | Нет | Идентификатор ресурса для поиска по email и phone |
Пример запроса
{
"code": "CODE-12345",
"db_id": 1,
"loyalty_id": 1,
"matching": "profile_id",
"profile_id": "abcdefghijklmnqrstuvwxyz",
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"data": null,
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |