Промокоды опроса
Управляйте списками промокодов и их привязкой к опросам
Промокоды опроса
Модуль промокодов позволяет ограничивать доступ к опросу, проводить акции и считать конверсии за счёт списков кодов, привязанных к конкретным квизам. Этот раздел описывает работу со списками промокодов и отдельными кодами через API v3.
Базовый префикс для всех эндпоинтов промокодов:
/quiz/{id}/promo,
где id — ID опроса.
Краткий обзор эндпоинтов
| HTTP | Endpoint | Назначение |
|---|---|---|
| GET | /quiz/{id}/promo/list | Получить списки промокодов воркспейса |
| POST | /quiz/{id}/promo/list | Создать список промокодов |
| GET | /quiz/{id}/promo/codes | Получить коды выбранного списка |
| POST | /quiz/{id}/promo/codes | Добавить коды в список |
| POST | /quiz/{id}/promo/attach/{list_id} | Привязать список промокодов к опросам |
| POST | /quiz/{id}/promo/detach | Отвязать список от опросов |
Списки промокодов
Список промокодов объединяет отдельные коды (например, для одной акции) и может быть привязан к нескольким опросам. Через API можно получить списки, создавать новые и изменять существующие.
Получить списки промокодов
Возвращает постраничный список списков промокодов с количеством кодов и привязанных опросов.
GET /quiz/{id}/promo/list
| Параметр | Тип | Описание |
|---|---|---|
| search | string | Поиск по коду внутри списков |
| limit | integer | Количество элементов (1..500, по умолчанию 20) |
| offset | integer | Смещение выборки (по умолчанию 0) |
| sort | string | Поле сортировки: updated_at, name, id |
| order | string | Порядок сортировки: asc или desc (по умолчанию desc) |
Создать список промокодов
Создаёт новый список с набором кодов (до 1000 за раз).
POST /quiz/{id}/promo/list
Управление кодами и привязкой
После создания списка вы можете управлять отдельными кодами, импортировать их из файлов и привязывать/отвязывать списки к опросам.
- GET /quiz/{id}/promo/codes — получить коды списка.
- POST /quiz/{id}/promo/codes — добавить коды в список.
- DELETE /quiz/{id}/promo/codes/{code_id} — удалить код.
- POST /quiz/{id}/promo/import-file — импорт кодов из файла (txt/csv/xlsx/xls).
- POST /quiz/{id}/promo/attach/{list_id} — привязать список к опросам.
- POST /quiz/{id}/promo/detach — отвязать список от опросов.
Полные примеры тел запросов и ответов смотрите в разделе ## Промокоды опроса файла
api_v3.md или в LLM‑версии /static/api/promocodes.md.