Set a family scheduling preference

Saves the family's preferred PTA appointment window or preference type for the selected event.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
family_student_idintegerRequired
pta_event_idintegerRequired
pta_scheduling_preference_type_idinteger or nullOptional
start_timestring or nullOptionalformat: "^\\d{2}:\\d{2}:\\d{2}$"
end_timestring or nullOptionalformat: "^\\d{2}:\\d{2}:\\d{2}$"

Response

Preference saved
statusstringOptional
messagestringOptional
datamap from strings to anyOptional

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error