Привязать промокод к профилю

Описание

Назначить промокод подписчику.

Если в запрос передан параметр "code", то выполняется поиск по данному коду.

Будет назначен:

• Если промокод найден (присоединён к множественным профилям или свободен).
• Если промокод не найден, и разрешено создание новых.

Если в запрос не передан параметр "code", то будет назначен промокод из программы лояльности (если есть свободные или разрешено создание новых).

URL-адрес

Метод: POST

https://example.com/api/v1.1/promocodes/attach

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
code	string	"CODE-12345"	Нет	Код
db_id	int	1	Да	Идентификатор базы данных
format	string	"json"	Нет	Формат возвращаемых данныхbr/>(по умолчанию – "json")
loyalty_id	int	1	Да	Идентификатор программы лояльности
Поиск профиля подписчика
matching	string	"email" "email_profile" "phone" "profile_id" "custom"	Нет, если поиск по email из профиля или подписок	Режим поиска подписчика (по умолчанию - 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

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "db_id": 1,
    "matching": "profile_id",
    "profile_id": "abcdefghijklmnqrstuvwxyz",
    "loyalty_id": 5,
    "code": "CODE-1"
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <db_id>1</db_id>    
    <matching>profile_id</matching>
    <profile_id>abcdefghijklmnqrstuvwxyz</profile_id>
    <loyalty_id>5</loyalty_id>
    <code>CODE-1</code>
</xml>

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

JSON

{
    "data": null,
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data/>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки