Skip to main content
PATCH
Update student dates and transition rooms

Authorizations

Authorization
string
header
required

Access token issued by POST /sessions and associated with a valid server-side session.

Path Parameters

id
string<uuid>
required

UUID identifying this resource.

Query Parameters

company_id
string<uuid>
required

Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.

school_id
string<uuid>
required

School UUID. Must be assigned to the authenticated session.

Body

application/json

Update Student Request.

start_date_ems_entry
required

Omit to retain the existing value. Null or an empty/whitespace-only string clears it. Nonempty strings are trimmed.

updated_by_email
string

Accepted for compatibility, but attribution uses the authenticated session user and ignores this value.

transition_date

Omit to retain the existing value. Null or an empty/whitespace-only string clears it. Nonempty strings are trimmed.

transition_room_override_id

Omit to retain the existing value. Null or an empty/whitespace-only string clears it. Nonempty strings are trimmed.

transition_date_2

Omit to retain the existing value. Null or an empty/whitespace-only string clears it. Nonempty strings are trimmed.

transition_room_2_id

Omit to retain the existing value. Null or an empty/whitespace-only string clears it. Nonempty strings are trimmed.

withdrawal_date_ems_entry

Omit to retain the existing value. Null or an empty/whitespace-only string clears it. Nonempty strings are trimmed.

withdrawal_date_estimated

Omit to retain the existing value. Null or an empty/whitespace-only string clears it. Nonempty strings are trimmed.

Response

Successful response.

Update Student Response.

company_id
string
required

Company id.

school_id
string
required

School id.

student_id
string
required

Student id.

updated_by_email
string
required
updated_by_user_id
string
required

Updated by user id.

student_data
object | null
required

Student Data.