Function: patchGroupsById()

patchGroupsById<ThrowOnError>(options): RequestResult<PatchGroupsByIdResponses, PatchGroupsByIdErrors, ThrowOnError>

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

Performs a partial update on an existing group's properties using a JSON Patch document. The PatchGroup endpoint allows clients to modify specific fields of a group without providing the entire resource representation. This is particularly useful for making small adjustments to group metadata while minimizing data transfer. The endpoint validates the patch operations against the group domain model and ensures that the user is authorized to perform these specific modifications before applying changes to the database.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchGroupsByIdData, ThrowOnError>

Returns

RequestResult<PatchGroupsByIdResponses, PatchGroupsByIdErrors, ThrowOnError>