Save registration year settings

POST

https://ssuccessv2.com/app/api/v2/registration/year/settings/:year_id

POST

/app/api/v2/registration/year/settings/:year_id

$ curl -X POST https://ssuccessv2.com/app/api/v2/registration/year/settings/12 \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "registration_phase_id": 3,
>   "start_at": {},
>   "end_at": {},
>   "title": "2026-2027",
>   "registration_opens": {},
>   "registration_closes": {},
>   "early_bird_ends": {},
>   "early_bird_discount": 10,
>   "early_bird_discount_type": "percentage",
>   "early_bird_contract_fees_type_ids": [
>     2
>   ],
>   "registration_steps": [
>     "family",
>     "students",
>     "contract"
>   ]
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "registration_phase_id": 3,
6     "title": "2026-2027",
7     "start_at": {},
8     "end_at": {},
9     "registration_steps": [
10       "family",
11       "students",
12       "contract"
13     ]
14   }
15 }

Updates academic-year dates and title together with the selected registration phase’s dates, early-bird discount, fee types, and ordered steps.

Authentication

AuthorizationBearer

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

Path parameters

year_idintegerRequired>=1

Academic year identifier.

Request

This endpoint expects an object.

registration_phase_idintegerOptional>=1

start_atdateOptional

end_atdateOptional

titlestringOptional

registration_opensdatetimeOptional

registration_closesdatetimeOptional

early_bird_endsdatetimeOptional

early_bird_discountdoubleOptional

early_bird_discount_typeenumOptional

Allowed values:

early_bird_contract_fees_type_idslist of integersOptional

registration_stepslist of stringsOptional

Response

Registration year settings were saved and returned.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error