Function: postMailsActivity()

postMailsActivity<ThrowOnError>(options?): RequestResult<PostMailsActivityResponses, PostMailsActivityErrors, ThrowOnError>

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

Sends an activity-specific email notification using specialized templates and data. The PostActivityMail endpoint is designed to handle communications related specifically to system activities, such as enrollment confirmations or activity updates. By utilizing the PostActivityMailDTO, clients can trigger emails that are context-aware, ensuring that relevant activity data is correctly injected into the communication. This endpoint enforces strict authorization to prevent unauthorized users from sending activity-related notifications and provides clear feedback through appropriate HTTP status codes in case of delivery failure or permission issues.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<PostMailsActivityData, ThrowOnError>

Returns

RequestResult<PostMailsActivityResponses, PostMailsActivityErrors, ThrowOnError>