Function: putAnnouncementsById()

putAnnouncementsById<ThrowOnError>(options): RequestResult<PutAnnouncementsByIdResponses, PutAnnouncementsByIdErrors, ThrowOnError>

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

Updates a specific announcement by its unique identifier with the provided data. The PutAnnouncement endpoint allows clients to submit a request to update an existing announcement by providing the necessary information in the UpdateAnnouncementDTO. This endpoint is designed to handle the updating of announcements, ensuring that the provided data is validated and processed correctly, while also enforcing proper authorization to ensure that only authorized users can update existing announcements within the system. Upon successful update, the endpoint returns a 204 No Content status code, indicating that the announcement has been successfully updated without returning any content in the response body, allowing clients to easily manage and modify announcement details as needed.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PutAnnouncementsByIdData, ThrowOnError>

Returns

RequestResult<PutAnnouncementsByIdResponses, PutAnnouncementsByIdErrors, ThrowOnError>