API Reference

Print Mail

Reports

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update Report

print_mail.reports.update(strid, ReportUpdateParams**kwargs) -> Report

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

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

ParametersExpand Collapse

id: str

description: Optional[str]

An optional user-friendly description for the report. Set to null to remove.

metadata: Optional[Dict[str, str]]

Optional key-value metadata associated with the report. Set to null to remove.

sql_query: Optional[str]

The SQL query defining the report.

ReturnsExpand Collapse

class Report: …

Represents a saved Report definition.

id: str

Unique identifier for the report.

created_at: datetime

Timestamp when the report was created.

formatdate-time

live: bool

Indicates if the report is associated with the live or test environment.

object: Literal["report"]

Always report.

sql_query: str

The SQL query defining the report.

updated_at: datetime

Timestamp when the report was last updated.

formatdate-time

description: Optional[str]

An optional user-friendly description for the report.

metadata: Optional[Dict[str, str]]

Optional key-value metadata associated with the report.

Update Report

Python

HTTP

TypeScript

Python

import os
from postgrid import PostGrid

client = PostGrid(
    print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"),  # This is the default and can be omitted
)
report = client.print_mail.reports.update(
    id="id",
    description="Recent Orders (Updated)",
)
print(report.id)

200 example

{
  "id": "report_123",
  "object": "report",
  "live": false,
  "sqlQuery": "SELECT id, status FROM orders WHERE created_at > ?",
  "description": "Recent Orders",
  "metadata": {
    "team": "Sales"
  },
  "createdAt": "2023-10-27T10:00:00Z",
  "updatedAt": "2023-10-27T10:00:00Z"
}

Returns Examples

200 example

{
  "id": "report_123",
  "object": "report",
  "live": false,
  "sqlQuery": "SELECT id, status FROM orders WHERE created_at > ?",
  "description": "Recent Orders",
  "metadata": {
    "team": "Sales"
  },
  "createdAt": "2023-10-27T10:00:00Z",
  "updatedAt": "2023-10-27T10:00:00Z"
}