---
title: "Update Report"
method: POST
path: "/print-mail/v1/reports/{id}"
tags: ["Reports"]
---

# Update Report

`POST /print-mail/v1/reports/{id}`

Update an existing saved report definition. You can change the query, description, or metadata.

## Path parameters

- `id` string, required

## Request body

- ReportUpdate — Model for updating an existing Report.
  - `sqlQuery` string — The SQL query defining the report.
  - `description` string, nullable — An optional user-friendly description for the report. Set to null to remove.
  - `metadata` object, nullable — Optional key-value metadata associated with the report. Set to null to remove.

## Response `200`

The updated Report object.

- Report — Represents a saved Report definition.
  - `id` string, required — Unique identifier for the report.
  - `object` 'report', required — Always `report`.
  - `live` boolean, required — Indicates if the report is associated with the live or test environment.
  - `sqlQuery` string, required — The SQL query defining the report.
  - `description` string — An optional user-friendly description for the report.
  - `metadata` object — Optional key-value metadata associated with the report.
  - `createdAt` string, date-time, required — Timestamp when the report was created.
  - `updatedAt` string, date-time, required — Timestamp when the report was last updated.

## Other responses

- `400` — The updated Report object.
- `401` — The updated Report object.
- `404` — The updated Report object.
- `422` — The updated Report object.
- `429` — The updated Report object.
- `500` — The updated Report object.

---

[API](https://skmtc.net/postgrid/apis/postgrid-print-mail-api.md) · [All operations](https://skmtc.net/postgrid/apis/postgrid-print-mail-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/postgrid/postgrid-print-mail-api/versions/6bb9d268c5d1/schema)