Function: patchStudyenrollmentsById()

patchStudyenrollmentsById<ThrowOnError>(options): RequestResult<PatchStudyenrollmentsByIdResponses, PatchStudyenrollmentsByIdErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:1108

Partially updates an existing study enrollment using a JSON Patch document. The PatchStudy endpoint (targeting a specific StudyEnrollment) allows for the modification of specific enrollment attributes—such as adjusting a graduation date or changing a status—without the need to resend the entire record. This ensures that updates are targeted and efficient. The endpoint validates the proposed changes against the enrollment domain rules and verifies the user's authority to modify the record before persisting the changes.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchStudyenrollmentsByIdData, ThrowOnError>

Returns

RequestResult<PatchStudyenrollmentsByIdResponses, PatchStudyenrollmentsByIdErrors, ThrowOnError>