Function: putGroupsById()

putGroupsById<ThrowOnError>(options): RequestResult<PutGroupsByIdResponses, PutGroupsByIdErrors, ThrowOnError>

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

Updates the entire representation of an existing group with the provided data. The PutActivity endpoint replaces the current group information with the data provided in the GroupUpdateDTO. This endpoint is typically used for comprehensive updates where multiple group attributes are changed simultaneously. It enforces authorization to ensure only group managers can perform the update and provides detailed error handling for validation failures or missing resources, returning a 204 No Content status upon a successful operation.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PutGroupsByIdData, ThrowOnError>

Returns

RequestResult<PutGroupsByIdResponses, PutGroupsByIdErrors, ThrowOnError>