Function: putMailinglistsById()

putMailinglistsById<ThrowOnError>(options): RequestResult<PutMailinglistsByIdResponses, PutMailinglistsByIdErrors, ThrowOnError>

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

Updates an existing mailing list identified by its ID. This endpoint allows authorized users to modify the details of an existing mailing list by providing the updated information in the request body, encapsulated in the PostMailinglistDTO. The method calls the UpdateMailinglist function of the IMailinglistService, passing the ID, DTO, user ID, and cancellation token to handle the update logic. If the update 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 crucial for users to maintain accurate and up-to-date mailing list information within the application.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PutMailinglistsByIdData, ThrowOnError>

Returns

RequestResult<PutMailinglistsByIdResponses, PutMailinglistsByIdErrors, ThrowOnError>