Create a registration requirement

POST

https://ssuccessv2.com/app/api/v2/registration/setup/create

Creates a custom file, checkbox, document template, or form requirement for an academic year.

AuthorizationBearer

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

This endpoint expects an object.

batch_idintegerRequired

registration_phase_idintegerOptional>=1

namestring or nullOptional

descriptionstring or nullOptional

requirement_detailsmap from strings to any or nullOptional

is_requiredbooleanOptional

is_editablebooleanOptional

is_publicbooleanOptional

relates_toenum or nullOptional

Allowed values:

sort_orderintegerOptional

typeenumOptional

Allowed values:

fileinteger or nullOptional

file_category_idinteger or nullOptional

document_templateinteger or nullOptional

form_idinteger or nullOptional

Registration requirement created

statusstring

messagestring

datamap from strings to any

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/registration/setup/create \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"batch_id": 2026,
>	"registration_phase_id": 4,
>	"name": "Proof of address",
>	"description": "Upload a current proof of address.",
>	"is_public": true,
>	"relates_to": "family",
>	"type": "file",
>	"file_category_id": 6
>	}'

1	{
2	"status": "success",
3	"message": "Created successfully.",
4	"data": {
5	"id": 412,
6	"batch_id": 2026,
7	"type": "file",
8	"name": "Proof of address",
9	"is_required": false,
10	"attachments": [],
11	"document_templates": []
12	}
13	}