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).

Path parameters

integer
required
ID of the form layout to update. The layout must belong to the current school.

Request parameters

All request body parameters are optional. Pass only the fields you want to update.
enum
Form layout mode. Possible values: Custom, Form, Signup, Welcome, Participant.
string
Form layout name. Maximum 255 characters.
string
Internal layout name. Maximum 255 characters.
enum
Layout status. Possible values: Draft, Published.
string
Layout slug. From 1 to 50 characters. Must be unique within the seller (school).
string
Layout note. Maximum 255 characters.
integer[]
Array of IDs of the products the layout is linked to. When passed, it fully replaces the current list of linked products.
object
Layout settings.

Permission requirements

Updating a form layout requires the service user to have the “Forms management” permission (FormManage).
The layout must belong to the current school (checked automatically).
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