GoodData.UI API reference
  • All Products
  • All Products
  • GoodData.UI
  • API Reference
  • University
  • Community
  • Documentation
  • Support
  • 11.1.0
  • Code samples
  • GitHub

updateScheduledMail()

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

IWorkspaceDashboardsService.updateScheduledMail() 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.

Update existing scheduled mail for the dashboard

Signature:

updateScheduledMail(ref: ObjRef, scheduledMail: IScheduledMailDefinition, filterContextRef?: ObjRef): Promise<void>;

Parameters

Parameter

Type

Description

ref

ObjRef

reference to the existing scheduled email object

scheduledMail

IScheduledMailDefinition

scheduled email definition

filterContextRef

ObjRef

(Optional) optional reference to an existing filter context to be used in all attachments

Returns:

Promise<void>

promise of the updated scheduled email

  • IWorkspaceDashboardsService.updateScheduledMail() method
  • Parameters
GoodData resources:
  • Documentation
Follow the community:
  • Community
Copyright © 2007–2025 GoodData Corporation. All Rights Reserved. Code licensed under a dual license - CC BY‑NC 4.0 for trial experience and GoodData.UI EULA for commercial use