---
title: "Update Report"
method: PATCH
path: "/schedule/report/{id}"
tags: ["Schedule"]
---

# Update Report

`PATCH /schedule/report/{id}`

Used to update existing report

## Path parameters

- `id` string, required

## Headers

- `If-Match` string

## Request body

- Report — A report specification
  - `id` string — The id of this report
  - `created_time` integer — time the report was created
  - `created_by_id` string — The ID of the user who created this report
  - `last_updated_time` integer — time the run policy object was last updated
  - `last_updated_by_id` string — The ID of the user who last updated this report
  - `name` string — The display name of the report
  - `description` string — Detailed description of this report
  - `report_type` 'plan_summary' | 'workspace_summary' — The type of report
  - `medium` 'email' — The medium we should deliver this report over
  - `organization_id` string — DEPRECATED - use workspace_id instead
  - `workspace_id` string — The workspace id this report relates to
  - `plan_id` string — The plan id this report relates to
  - `journey_id` string — The journey id this report relates to
  - `triggers` Trigger[]
    - `trigger_type` 'timer' | 'event' | 'schedule' | 'insight' | 'plan_execution' — The type of trigger
    - `properties` object — Properties that are specific to the trigger type
  - `tags` Tag[] — Free text tags associated with this entity
    - `name` string, required — tag name
    - `values` string[]
  - `emails` string[] — Set of emails to receive the plan report

## Response `200`

The updated report

- Report — A report specification
  - `id` string — The id of this report
  - `created_time` integer — time the report was created
  - `created_by_id` string — The ID of the user who created this report
  - `last_updated_time` integer — time the run policy object was last updated
  - `last_updated_by_id` string — The ID of the user who last updated this report
  - `name` string — The display name of the report
  - `description` string — Detailed description of this report
  - `report_type` 'plan_summary' | 'workspace_summary' — The type of report
  - `medium` 'email' — The medium we should deliver this report over
  - `organization_id` string — DEPRECATED - use workspace_id instead
  - `workspace_id` string — The workspace id this report relates to
  - `plan_id` string — The plan id this report relates to
  - `journey_id` string — The journey id this report relates to
  - `triggers` Trigger[]
    - `trigger_type` 'timer' | 'event' | 'schedule' | 'insight' | 'plan_execution' — The type of trigger
    - `properties` object — Properties that are specific to the trigger type
  - `tags` Tag[] — Free text tags associated with this entity
    - `name` string, required — tag name
    - `values` string[]
  - `emails` string[] — Set of emails to receive the plan report

## Other responses

- `404` — Report not found
- `default` — Unknown error

---

[API](https://skmtc.net/mabl/apis/mabl-api.md) · [All operations](https://skmtc.net/mabl/apis/mabl-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mabl/mabl-api/revisions/d0fc0114da66/schema)
