PostGroups

Function: postGroups()

postGroups<ThrowOnError>(options?): RequestResult<PostGroupsResponses, PostGroupsErrors, ThrowOnError>

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

Creates a new group within the system using the provided data. The PostGroup endpoint processes requests to establish a new group entity, taking inputs from the PostGroupDTO. This process includes validating the provided data, assigning ownership to the creating user, and persisting the new group to the data store. Upon successful creation, the endpoint returns the newly created group's details and its unique location, following standard RESTful practices for resource creation.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<PostGroupsData, ThrowOnError>

Returns

RequestResult<PostGroupsResponses, PostGroupsErrors, ThrowOnError>

On this page