Function: putGroupmembershipsById()

putGroupmembershipsById<ThrowOnError>(options): RequestResult<PutGroupmembershipsByIdResponses, PutGroupmembershipsByIdErrors, ThrowOnError>

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

Fully updates a specific group membership by its unique identifier. The PutGroupMembership endpoint allows clients to submit a request to replace an existing group membership with new data based on the provided ID. This endpoint ensures that the requesting user is authorized to update the group membership and processes the update logic through the IGroupMembershipService. Upon successful update, it returns a 204 No Content status code, indicating that the group membership has been successfully updated without returning any content in the response body. 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<PutGroupmembershipsByIdData, ThrowOnError>

Returns

RequestResult<PutGroupmembershipsByIdResponses, PutGroupmembershipsByIdErrors, ThrowOnError>