---
title: "Turn a dashboard's email updates on, off, or change them"
method: PUT
path: "/dashboards/{dashboard_id}/email-updates"
tags: ["Dashboard"]
---

# Turn a dashboard's email updates on, off, or change them

`PUT /dashboards/{dashboard_id}/email-updates`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/dashboards/{dashboard_id}/email-updates`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

## Path parameters

- `dashboard_id` integer, required

## Request body

- EmailUpdateSettingsBody
  - `enabled` boolean, required
  - `trigger` 'new_data' | 'schedule': What decides that an email update goes out.
  - `timezone` string, required
  - `frequency` 'daily' | 'weekdays' | 'weekly' | 'monthly': How often an update repeats (a new-data update is checked daily).
  - `weekday` integer, nullable
  - `monthday` integer, nullable
  - `time_of_day` string
  - `numbers` object: {dashboard_id: [KPI keys]} — at most 3 per dashboard

## Response `200`

Email updates

- EmailUpdatesOut
  - `update` EmailUpdateOut
    - `id` integer, required
    - `enabled` boolean, required
    - `trigger` 'new_data' | 'schedule', required: What decides that an email update goes out.
    - `frequency` 'daily' | 'weekdays' | 'weekly' | 'monthly', required: How often an update repeats (a new-data update is checked daily).
    - `weekday` integer, nullable
    - `monthday` integer, nullable
    - `time_of_day` string, required
    - `timezone` string, required
    - `numbers` object, required
    - `next_run_at` string, date-time, nullable
    - `last_run_at` string, date-time, nullable
    - `last_status` string, nullable
    - `last_detail` string, nullable
    - `last_delivered` integer
    - `left_out` object
  - `people` integer, required
  - `unsubscribed` string[], required
  - `boards` BoardPreviewOut[], required
    - `dashboard_id` integer, required
    - `title` string, required
    - `published` boolean, required
    - `rls` boolean, required: Limits rows by viewer: each reader gets their own numbers
    - `figures` FigureOut[], required
      - `key` string, required
      - `label` string, required
      - `value` string, nullable
    - `choices` FigureOut[], required
      - `key` string, required
      - `label` string, required
      - `value` string, nullable
  - `covered_by` string[]: Collections holding this dashboard whose updates are on

## Other responses

- `400`: Bad request syntax or unsupported method

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/fe078afe239b?raw)