Create a form

POST

https://ssuccessv2.com/app/api/v1/forms

Creates an active-school form after validating its schemas, audience, receipt settings, and optional payment configuration.

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

This endpoint expects an object.

namestringRequired<=255 characters

academic_year_idintegerRequired

activebooleanRequired

data_schemalist of maps from strings to anyRequired

JSON-schema field definitions

ui_schemalist of maps from strings to anyRequired

Form UI schema

recaptchabooleanRequired

email_receiptbooleanRequired

thank_you_messagestring or nullOptional

form_audience_idinteger or nullOptional

payment_settingsmap from strings to any or nullOptional

thank_you_iconstring or nullOptional

thank_you_icon_colorstring or nullOptional

Form created.

statusenum

messagestring

dataobject

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/forms \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "2026-2027 Enrollment Form",
>	"academic_year_id": 2026,
>	"active": true,
>	"data_schema": [
>	{
>	"key": "student_name",
>	"type": "string",
>	"title": "Student name"
>	}
>	],
>	"ui_schema": [
>	{
>	"ui:widget": "TextWidget",
>	"key": "student_name"
>	}
>	],
>	"recaptcha": true,
>	"email_receipt": true,
>	"payment_settings": {
>	"enabled": false
>	}
>	}'