Skip to main content

Заголовки запроса

string
обязательно
API-токен сервисного пользователя в формате Bearer YOUR_TOKEN. Токен выпускает владелец школы в кабинете: Управление → Школа → Для разработчиков → API-ключи — подробнее в разделе «Аутентификация».
integer
обязательно
Числовой ID продавца — аккаунта, которому принадлежит школа. Скопируйте его на странице API-ключи в карточке «Данные для интеграции → Идентификаторы». По этому ID проверяются права токена.
integer
обязательно
Числовой ID школы, берётся там же, где Seller-Id. Значение должно совпадать со школой продавца — иначе вернётся ошибка 400 с cause: "ForbiddenSchoolMismatch".
Требуется аутентификация и право «Управление формами» (FormManage).
Макет и кастомные поля. Макет формы — это контейнер для полей. Через API создаётся только сам макет; поля в нём (их тип и slug) добавляются в кабинете школы. Значения полей для конкретных пользователей читаются и записываются методами получения и установки значений, где макет передаётся как layoutId — это id из ответа этого метода.

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

enum
обязательно
Режим макета формы. Определяет где и как будет использоваться форма.Возможные значения:
  • Custom — кастомные поля пользователя
  • Form — заполняемая форма (анкета)
  • Signup — форма при регистрации (уникальная для школы)
  • Welcome — приветственная форма (уникальная для школы)
  • Participant — форма участника продукта
string
обязательно
Название макета формы. Максимум 255 символов.
string
обязательно
Внутреннее название макета. Максимум 255 символов. Используется для идентификации макета в интерфейсе управления.
enum
Статус макета. Возможные значения: Draft, Published. По умолчанию Draft.
string
Символьный код макета. От 1 до 50 символов. Должен быть уникальным в рамках продавца (школы).
string
Заметка к макету. Максимум 255 символов.
integer[]
Массив ID продуктов, к которым привязан макет, — поле productId из списка курсов.
object
Настройки макета.
Для режимов Signup и Welcome допускается только один макет на продавца (школу). При попытке создать второй макет с тем же режимом будет возвращена ошибка LayoutWithModeAlreadyExists.

Требования к правам доступа

Для создания макета формы требуется право «Управление формами» (FormManage) у сервисного пользователя.
Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.

Обновлено: 2026-09-25 13:43 UTC