Type Alias: PostMailinglistDto

[object Object]

Defined in: app/api/types.gen.ts:1250

Data Transfer Object for creating or updating a mailing list. The PostMailinglistDTO class encapsulates the necessary information required to create or update a mailing list entity, including the Name of the mailing list and the ServiceId that identifies the associated email service. This DTO is used in the Mailinglists controller to receive data from client requests when creating new mailing lists or updating existing ones, ensuring that the required fields are provided and structured correctly for processing by the underlying business logic in the MailinglistService.

Properties

name?

optional name?: string

Defined in: app/api/types.gen.ts:1254

Gets or sets the name of the mailing list. This property provides a human-readable name for the mailing list, which is used for display purposes in the user interface and for identifying the mailing list in logs and other outputs. The name should be descriptive enough to convey the purpose of the mailing list to users, such as "General Member Meetings" or "Company Mails".

---

serviceId?

optional serviceId?: string

Defined in: app/api/types.gen.ts:1258

Gets or sets the service ID associated with the mailing list. This property is used to link the mailing list to an external email service, allowing for integration with third-party email providers for sending communications to subscribers. The ServiceId can be used to store identifiers such as API keys, list IDs, or other relevant information needed to manage the mailing list within the context of the external service.