Skip to main content

Request headers

string
required
The service user’s API token in the Bearer YOUR_TOKEN format. The school owner issues the token in the admin panel: Manage → School → For developers → API keys — see the “Authentication” section for details.
integer
required
The numeric ID of the seller — the account the school belongs to. Copy it on the API keys page, in the Integration data → Identifiers card. The token’s permissions are checked against this ID.
integer
required
The numeric ID of the school, found in the same place as Seller-Id. The value must match the seller’s school — otherwise a 400 error with cause: "ForbiddenSchoolMismatch" is returned.
Requires authentication and the “Forms management” permission (FormManage).
Layout and custom fields. A form layout is a container for fields. Only the layout itself is created via the API; the fields in it (their type and slug) are added in the school’s admin panel. Field values for specific users are read and written with the get and set values methods, where the layout is passed as layoutId — the id from this method’s response.

Request parameters

enum
required
Form layout mode. Determines where and how the form is used.Possible values:
  • Custom — user custom fields
  • Form — a fillable form (questionnaire)
  • Signup — sign-up form (one per school)
  • Welcome — welcome form (one per school)
  • Participant — product participant form
string
required
Form layout name. Up to 255 characters.
string
required
Internal layout name. Up to 255 characters. Used to identify the layout in the management interface.
enum
Layout status. Possible values: Draft, Published. Defaults to Draft.
string
Symbolic code of the layout. From 1 to 50 characters. Must be unique within the seller (school).
string
A note for the layout. Up to 255 characters.
integer[]
An array of IDs of products the layout is bound to — the productId field from the course list.
object
Layout settings.
For the Signup and Welcome modes, only one layout per seller (school) is allowed. Attempting to create a second layout with the same mode returns the LayoutWithModeAlreadyExists error.

Permission requirements

Creating a form layout requires the service user to have the “Forms management” permission (FormManage).
The service user must be authenticated with a token and have the appropriate access permissions for the specified school.

Updated: 2026-09-25 14:33 UTC