Function: patchStudiesById()

patchStudiesById<ThrowOnError>(options): RequestResult<PatchStudiesByIdResponses, PatchStudiesByIdErrors, ThrowOnError>

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

Partially updates the properties of an existing study using a JSON Patch document. The PatchStudy endpoint allows for precise modifications—such as renaming a program or updating a specific attribute—without requiring the submission of the full study object. This approach is efficient and minimizes data transfer, while ensuring that all changes are validated against business rules and authorized by the proper security checks.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchStudiesByIdData, ThrowOnError>

Returns

RequestResult<PatchStudiesByIdResponses, PatchStudiesByIdErrors, ThrowOnError>