Function: patchAnnouncementsById()

patchAnnouncementsById<ThrowOnError>(options): RequestResult<PatchAnnouncementsByIdResponses, PatchAnnouncementsByIdErrors, ThrowOnError>

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

Partially updates a specific announcement by its unique identifier using a JSON Patch document. The PatchAnnouncement endpoint allows clients to submit a request to modify an existing announcement by providing a JSON Patch document that specifies the changes to be made to the announcement's properties. This endpoint is designed to handle partial updates of announcements, 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 announcements within the system. Upon successful application of the patch, 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. This approach allows for efficient updates to announcement data without requiring clients to send the entire announcement object, enabling more flexible and targeted modifications to announcement properties as needed.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchAnnouncementsByIdData, ThrowOnError>

Returns

RequestResult<PatchAnnouncementsByIdResponses, PatchAnnouncementsByIdErrors, ThrowOnError>