Function: deleteAnnouncementsById()

deleteAnnouncementsById<ThrowOnError>(options): RequestResult<DeleteAnnouncementsByIdResponses, DeleteAnnouncementsByIdErrors, ThrowOnError>

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

Deletes a specific announcement by its unique identifier. The DeleteAnnouncement endpoint allows clients to remove an existing announcement from the system based on the provided ID. This endpoint is designed to handle the deletion of announcements, ensuring that proper authorization is enforced to allow only authorized users to delete announcements, while also providing appropriate error handling for cases where the announcement may not be found or the user does not have access rights. Upon successful deletion, the endpoint returns a 204 No Content status code, indicating that the announcement has been successfully removed from the system without returning any content in the response body.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<DeleteAnnouncementsByIdData, ThrowOnError>

Returns

RequestResult<DeleteAnnouncementsByIdResponses, DeleteAnnouncementsByIdErrors, ThrowOnError>