Function: deleteMailinglistsById()

deleteMailinglistsById<ThrowOnError>(options): RequestResult<DeleteMailinglistsByIdResponses, DeleteMailinglistsByIdErrors, ThrowOnError>

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

Deletes an existing mailing list identified by its ID. This endpoint allows authorized users to remove a mailing list from the system. The method calls the DeleteMailinglist function of the IMailinglistService, passing the ID, user ID, and cancellation token to handle the deletion logic. If the deletion is successful, it returns an HTTP 204 No Content response; if the mailing list is not found, a 404 Not Found response is returned. The endpoint also handles exceptions, returning a 403 Forbidden response for unauthorized access and a 400 Bad Request response for other errors. This functionality is essential for users to manage their mailing lists effectively by removing those that are no longer needed.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<DeleteMailinglistsByIdData, ThrowOnError>

Returns

RequestResult<DeleteMailinglistsByIdResponses, DeleteMailinglistsByIdErrors, ThrowOnError>