createScheduledMail()

Home > @gooddata/sdk-backend-spi > IWorkspaceDashboardsService > createScheduledMail

IWorkspaceDashboardsService.createScheduledMail() method

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Create scheduled mail for the dashboard

Signature:

createScheduledMail(scheduledMail: IScheduledMailDefinition, exportFilterContext?: IFilterContextDefinition): Promise<IScheduledMail>;

Parameters

ParameterTypeDescription
scheduledMailIScheduledMailDefinitionscheduled email definition
exportFilterContextIFilterContextDefinition(Optional) override dashboard filter context with the custom filter context during the export

Returns:

Promise<IScheduledMail>

promise of the created scheduled email