Function: patchGroupmembershipsById()

patchGroupmembershipsById<ThrowOnError>(options): RequestResult<PatchGroupmembershipsByIdResponses, PatchGroupmembershipsByIdErrors, ThrowOnError>

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

Partially updates a specific group membership by its unique identifier using a JSON Patch document. The PatchGroupMembership endpoint allows clients to submit a request to modify an existing group membership by providing a JSON Patch document that specifies the changes to be made to the group membership's properties. This endpoint is designed to handle partial updates of group memberships, ensuring that the provided patch document is validated and applied correctly, while also enforcing proper authorization to ensure that only authorized users can modify existing group memberships within the system. Upon successful application of the patch, the endpoint returns a 204 No Content status code, indicating that the group membership has been successfully updated without returning any content in the response body. This approach allows for efficient updates to group membership data without requiring clients to send the entire group membership object, enabling more flexible and targeted modifications to group membership properties as needed.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchGroupmembershipsByIdData, ThrowOnError>

Returns

RequestResult<PatchGroupmembershipsByIdResponses, PatchGroupmembershipsByIdErrors, ThrowOnError>