Function: postAnnouncements()

postAnnouncements<ThrowOnError>(options?): RequestResult<PostAnnouncementsResponses, PostAnnouncementsErrors, ThrowOnError>

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

Creates a new announcement based on the provided data. The PostAnnouncement endpoint allows clients to submit a request to create a new announcement by providing the necessary information in the PostAnnouncementDTO. This endpoint is designed to handle the creation of announcements, ensuring that the provided data is validated and processed correctly, while also enforcing proper authorization to ensure that only authorized users can create new announcements within the system. Upon successful creation, the endpoint returns the details of the newly created announcement along with a 201 Created status code, allowing clients to easily access and reference the new announcement in subsequent operations.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<PostAnnouncementsData, ThrowOnError>

Returns

RequestResult<PostAnnouncementsResponses, PostAnnouncementsErrors, ThrowOnError>