Function: postGroupmemberships()

postGroupmemberships<ThrowOnError>(options?): RequestResult<PostGroupmembershipsResponses, PostGroupmembershipsErrors, ThrowOnError>

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

Creates a new group membership based on the provided data. The PostGroupMembership endpoint allows clients to submit a request to create a new group membership by providing the necessary information in the form of a PostGroupMembershipDTO. This endpoint ensures that the requesting user is authorized to create a group membership and processes the creation logic through the IGroupMembershipService. Upon successful creation, it returns a 201 Created status code along with the details of the newly created group membership in the response body. If the user is not authorized to perform this action, it returns a 403 Forbidden status code, and 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<PostGroupmembershipsData, ThrowOnError>

Returns

RequestResult<PostGroupmembershipsResponses, PostGroupmembershipsErrors, ThrowOnError>