Function: deleteGroupmembershipsById()

deleteGroupmembershipsById<ThrowOnError>(options): RequestResult<DeleteGroupmembershipsByIdResponses, DeleteGroupmembershipsByIdErrors, ThrowOnError>

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

Deletes a specific group membership by its unique identifier. The DeleteGroupMembership endpoint allows clients to submit a request to remove an existing group membership based on the provided ID. This endpoint ensures that the requesting user is authorized to delete the group membership and processes the deletion logic through the IGroupMembershipService. Upon successful deletion, it returns a 204 No Content status code, indicating that the group membership has been successfully removed. If the specified group membership does not exist, it returns a 404 Not Found status code, and if the user is not authorized to perform this action, it returns a 403 Forbidden status code. Additionally, any other exceptions encountered during the process will result in a 400 Bad Request response with an appropriate error message.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<DeleteGroupmembershipsByIdData, ThrowOnError>

Returns

RequestResult<DeleteGroupmembershipsByIdResponses, DeleteGroupmembershipsByIdErrors, ThrowOnError>