Function: patchEnrollmentsByActivityIdByMemberId()

patchEnrollmentsByActivityIdByMemberId<ThrowOnError>(options): RequestResult<PatchEnrollmentsByActivityIdByMemberIdResponses, PatchEnrollmentsByActivityIdByMemberIdErrors, ThrowOnError>

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

Partially updates a specific enrollment by its unique identifier using a JSON Patch document. The PatchEnrollment endpoint allows clients to submit a request to modify an existing enrollment by providing a JSON Patch document that specifies the changes to be made to the enrollment's properties. This endpoint is designed to handle partial updates of enrollments, ensuring that the provided patch document is validated and applied correctly, while also enforcing proper authorization to ensure that only authorized users can modify existing enrollments within the system. Upon successful application of the patch, the endpoint returns a 204 No Content status code, indicating that the enrollment has been successfully updated without returning any content in the response body. This approach allows for efficient updates to enrollment data without requiring clients to send the entire enrollment object, enabling more flexible and targeted modifications to enrollment properties as needed.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchEnrollmentsByActivityIdByMemberIdData, ThrowOnError>

Returns

RequestResult<PatchEnrollmentsByActivityIdByMemberIdResponses, PatchEnrollmentsByActivityIdByMemberIdErrors, ThrowOnError>