Update a calendar schedule

PUT

https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/:scheduleId

Replaces a calendar schedule's name, date range, cycle days, audiences, reporting term, and active state, then returns the refreshed resource.

AuthorizationBearer

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

scheduleIdintegerRequired>=1

Calendar schedule identifier.

This endpoint expects an object.

namestringRequired<=255 characters

dayslist of objectsRequired

report_card_term_idinteger or nullOptional

effective_start_datedate or nullOptional

effective_end_datedate or nullOptional

cycle_length_weeksintegerOptional1-52

activebooleanOptional

audienceslist of objectsOptional

The calendar schedule was updated and returned.

statusstringOptional

messagestringOptional

dataobjectOptional

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X PUT https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Revised timetable",
>	"days": [
>	{
>	"week_in_cycle": 1,
>	"day_of_week": 1,
>	"is_open": true,
>	"start_time": "08:00",
>	"end_time": "15:00"
>	}
>	],
>	"cycle_length_weeks": 1,
>	"active": true,
>	"audiences": [
>	{
>	"audience_type": "grade",
>	"audience_id": 7
>	}
>	]
>	}'

1	{
2	"status": "success",
3	"message": "Updated successfully.",
4	"data": {
5	"id": 31,
6	"name": "Revised timetable",
7	"active": true,
8	"days": [
9	{}
10	],
11	"audiences": [
12	{}
13	]
14	}
15	}