Function: deleteGroupsById()

deleteGroupsById<ThrowOnError>(options): RequestResult<DeleteGroupsByIdResponses, DeleteGroupsByIdErrors, ThrowOnError>

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

Permanently removes a group from the system based on its unique identifier. The DeleteGroup endpoint ensures that the requested group is deleted only after verifying that the requesting user has the necessary administrative permissions. This operation is destructive and removes all associated group metadata. Upon successful completion, the endpoint returns a 204 No Content status, signaling that the resource no longer exists without returning an unnecessary response body.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<DeleteGroupsByIdData, ThrowOnError>

Returns

RequestResult<DeleteGroupsByIdResponses, DeleteGroupsByIdErrors, ThrowOnError>